hbase-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "stack (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HBASE-482) package-level javadoc should have example client or at least point at the FAQ
Date Mon, 17 Mar 2008 18:28:25 GMT

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

stack commented on HBASE-482:
-----------------------------

Excellent.  I like the commentary above each line walking people along.

Make the class public.  Make sure it compiles and works.  Add note that presumes table already
created.  Perhaps finish w/ pointer at other things you can do programmatically -- point to
HBaseAdmin and scanners?

+1

> package-level javadoc should have example client or at least point at the FAQ
> -----------------------------------------------------------------------------
>
>                 Key: HBASE-482
>                 URL: https://issues.apache.org/jira/browse/HBASE-482
>             Project: Hadoop HBase
>          Issue Type: Wish
>          Components: documentation
>    Affects Versions: 0.1.0, 0.2.0, 0.16.0
>         Environment: Applies to all platform
>            Reporter: Andy Lee
>            Assignee: Bryan Duxbury
>            Priority: Blocker
>             Fix For: 0.1.0
>
>         Attachments: 482-0.1.patch
>
>   Original Estimate: 2h
>  Remaining Estimate: 2h
>
> Package-level javadoc should have example client or at least point at the FAQ that ties
to package release.
> For example, the BatchUpdate example code appears in the FAQ sample code, but it is missing
in the javadoc.
> It will be better to tie the example code snippet with the new methods that replaces
the deprecated methods which 
> will also be tied to release in the javadoc.

-- 
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