Re: Better Javadoc HTableDescriptor

2011-10-08 Thread Akash Ashok
Hi, Looking the the two methods 1. isMetaTable() - returns if table is meta and not root, i.e returns if the table represents .META. public boolean isMetaTable() { return isMetaRegion() !isRootRegion(); } 2. isMetaTable(String tableName) returns if a table is either .META. or

Re: Better Javadoc HTableDescriptor

2011-10-01 Thread Akash Ashok
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

Re: Better Javadoc HTableDescriptor

2011-10-01 Thread Doug Meil
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

Re: Better Javadoc HTableDescriptor

2011-10-01 Thread Akash Ashok
I totally agree that its not at all accepted if it causes compilation failures on upgrades. But the very name of the function is very misleading considering the fact that there is a .META. region and its very hard to distinguish between isMetaRegion() and isMetaTable(). We could definitely add

Re: Better Javadoc HTableDescriptor

2011-10-01 Thread Ted Yu
I prefer the fourth option. Only truly broken APIs should be removed. Cheers On Oct 1, 2011, at 10:02 AM, Doug Meil doug.m...@explorysmedical.com wrote: Be very careful about code-changes that causes compilation failures upon upgrade. Once in a while that may happen on a major upgrade,

Re: Better Javadoc HTableDescriptor

2011-10-01 Thread Dhruba Borthakur
+1 for Option 4. -dhruba On Sat, Oct 1, 2011 at 11:26 AM, Ted Yu yuzhih...@gmail.com wrote: I prefer the fourth option. Only truly broken APIs should be removed. Cheers On Oct 1, 2011, at 10:02 AM, Doug Meil doug.m...@explorysmedical.com wrote: Be very careful about code-changes

Re: Better Javadoc HTableDescriptor

2011-10-01 Thread Akash Ashok
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 dhr...@gmail.com wrote: +1 for Option 4. -dhruba On Sat, Oct 1, 2011 at 11:26

Re: Better Javadoc HTableDescriptor

2011-10-01 Thread Shumin Wu
Hello All, I am new here. So very nice to meet you guys. Here are my thoughts on this issue. I agree with Akash that the name of this method would confuse the user as there is a .META. notion that means something else. So why don't we create a function alias for isMetaTable() as a temporary

Re: Better Javadoc HTableDescriptor

2011-09-26 Thread Jean-Daniel Cryans
Be my guest! J-D On Sat, Sep 24, 2011 at 9:16 AM, Akash thehellma...@gmail.com 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

Better Javadoc HTableDescriptor

2011-09-24 Thread Akash
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