hbase-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jonathan Gray (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HBASE-1688) Improve javadocs in Result and KeyValue
Date Thu, 23 Jul 2009 02:43:14 GMT

    [ https://issues.apache.org/jira/browse/HBASE-1688?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12734434#action_12734434
] 

Jonathan Gray commented on HBASE-1688:
--------------------------------------

Forgot to mention, this was spurred by JD after he misused the new API by accident.  Thanks
jd.

Any other suggestions for improvement to the API or javadocs, now is the time!

> Improve javadocs in Result and KeyValue
> ---------------------------------------
>
>                 Key: HBASE-1688
>                 URL: https://issues.apache.org/jira/browse/HBASE-1688
>             Project: Hadoop HBase
>          Issue Type: Improvement
>          Components: client
>    Affects Versions: 0.20.0
>            Reporter: Jonathan Gray
>            Assignee: Jonathan Gray
>             Fix For: 0.20.0
>
>         Attachments: HBASE-1688-v1.patch
>
>
> Result has almost no class comment even though it is one of the most user-facing classes,
and is confusing because of exposure to KeyValue as well as all the nasty looking Maps.
> KeyValue is also documented with a purely server-side focus.  Should add some documentation
in the class comment and around those methods that will typically be used client-side.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message