[jira] [Commented] (HBASE-20876) Improve docs style in HConstants

["Wei-Chiu Chuang (JIRA)" <ji...@apache.org>]

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

Wei-Chiu Chuang commented on HBASE-20876:
-----------------------------------------

Thanks Reid for catching the issue!

I'll assign it to myself and work on it.

> Improve docs style in HConstants
> --------------------------------
>
>                 Key: HBASE-20876
>                 URL: https://issues.apache.org/jira/browse/HBASE-20876
>             Project: HBase
>          Issue Type: Improvement
>            Reporter: Reid Chan
>            Assignee: Wei-Chiu Chuang
>            Priority: Minor
>              Labels: beginner, beginners, newbie
>
> In {{HConstants}}, there's a docs snippet:
> {code}
>  /** Don't use it! This'll get you the wrong path in a secure cluster.
>   * Use FileSystem.getHomeDirectory() or
>   * "/user/" + UserGroupInformation.getCurrentUser().getShortUserName()  */
> {code}
> It's ugly style.
> Let's improve this docs with following
> {code}
> /**
>  * Description
>  */
> {code}



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)