Return-Path: X-Original-To: apmail-hbase-dev-archive@www.apache.org Delivered-To: apmail-hbase-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 0A45D9CCD for ; Sat, 1 Oct 2011 20:16:51 +0000 (UTC) Received: (qmail 56157 invoked by uid 500); 1 Oct 2011 20:16:50 -0000 Delivered-To: apmail-hbase-dev-archive@hbase.apache.org Received: (qmail 56128 invoked by uid 500); 1 Oct 2011 20:16:50 -0000 Mailing-List: contact dev-help@hbase.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@hbase.apache.org Delivered-To: mailing list dev@hbase.apache.org Received: (qmail 56120 invoked by uid 99); 1 Oct 2011 20:16:50 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 01 Oct 2011 20:16:50 +0000 X-ASF-Spam-Status: No, hits=1.5 required=5.0 tests=FREEMAIL_FROM,HTML_MESSAGE,RCVD_IN_DNSWL_LOW,SPF_PASS,T_TO_NO_BRKTS_FREEMAIL X-Spam-Check-By: apache.org Received-SPF: pass (athena.apache.org: domain of thehellmaker@gmail.com designates 209.85.213.41 as permitted sender) Received: from [209.85.213.41] (HELO mail-yw0-f41.google.com) (209.85.213.41) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 01 Oct 2011 20:16:45 +0000 Received: by ywe9 with SMTP id 9so3244788ywe.14 for ; Sat, 01 Oct 2011 13:16:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :content-type; bh=8W0Uhm7eMuRa2OXqcp7DS/Bamrg8Pd0DBoMbQ+tu2Oo=; b=eCDaLsa1cSuu8OSP6baX4cpjc22W/cWBcivAdCiMkcKfLT2wsRSMiyqWkusLu6EleA jTMB106gjj6oMMUPwoU0wGJymWTmnAVqd4hoWUa6xnFhEP5xeRQ0FueriR3aEOr4b03/ v3Ig1G7EPFmHDH6wyThw3aoXS7oLKKfxQdG5E= MIME-Version: 1.0 Received: by 10.236.177.2 with SMTP id c2mr22870755yhm.102.1317500184482; Sat, 01 Oct 2011 13:16:24 -0700 (PDT) Received: by 10.236.201.33 with HTTP; Sat, 1 Oct 2011 13:16:24 -0700 (PDT) In-Reply-To: References: <5314022B-FB7C-48CE-8FF0-195C2FCEF200@gmail.com> Date: Sun, 2 Oct 2011 01:46:24 +0530 Message-ID: Subject: Re: Better Javadoc HTableDescriptor From: Akash Ashok To: dev@hbase.apache.org Content-Type: multipart/alternative; boundary=20cf3040ebc47cd42e04ae426a76 --20cf3040ebc47cd42e04ae426a76 Content-Type: text/plain; charset=ISO-8859-1 Ok Thanks. I shall just add the javadoc. I've already opened a JIRA for improving the javadoc https://issues.apache.org/jira/browse/HBASE-4486 Cheers, Akash A On Sun, Oct 2, 2011 at 12:21 AM, Dhruba Borthakur wrote: > +1 for Option 4. > > -dhruba > > On Sat, Oct 1, 2011 at 11:26 AM, Ted Yu wrote: > > > I prefer the fourth option. > > Only truly broken APIs should be removed. > > > > Cheers > > > > On Oct 1, 2011, at 10:02 AM, Doug Meil > > wrote: > > > > > > > > Be very careful about code-changes that causes compilation failures > upon > > > upgrade. Once in a while that may happen on a major upgrade, but it > had > > > better be for a very good, explainable, reason that the community is > > > behind. > > > > > > > > > A fourth option is to add Javadoc to the explaining what this method > does > > > and not add any new methods. > > > > > > > > > On 10/1/11 8:02 AM, "Akash Ashok" wrote: > > > > > >> While I was doing this I found out that there is a method in > > >> HTableDescriptor called isMetaTable() which basically checks if the > > table > > >> is > > >> a catalog table and the name kind of misleading. I am planning to > rename > > >> this method to isCatalogTable(). > > >> > > >> 1. Is it ok to do this renaming considering that this is a client side > > >> API/ > > >> Admin API might lead to a lot of changes on client side for people > > already > > >> using this method? > > >> > > >> 2. If yes, is it ok to do it under the same JIRA HBase-4486 or should > > >> another another JIRA be file for this ? > > >> > > >> 3. If no, could this method be deprecated and another new method > > >> isCatalogTable() be added ? > > >> > > >> Cheers, > > >> Akash A > > >> > > >> On Mon, Sep 26, 2011 at 10:25 PM, Jean-Daniel Cryans > > >> wrote: > > >> > > >>> Be my guest! > > >>> > > >>> J-D > > >>> > > >>> On Sat, Sep 24, 2011 at 9:16 AM, Akash > wrote: > > >>>> Hi, > > >>>> I was just lookin at the HTableDescriptor and realized it has > very > > >>> minimal javadoc. Considering this is an admin API I feel there should > > be > > >>> better javadoc. If there's no Jira already open I would go ahead and > > >>> file > > >>> it. Thanks > > >>>> > > >>>> Sent from my iPhone > > >>> > > > > > > > > > -- > Connect to me at http://www.facebook.com/dhruba > --20cf3040ebc47cd42e04ae426a76--