[ https://issues.apache.org/jira/browse/HBASE-21243?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16646837#comment-16646837 ]
Nihal Jain edited comment on HBASE-21243 at 10/11/18 6:03 PM: -------------------------------------------------------------- I also felt the same, just copied the way {{getRequestUser()}} was doing it. Should I remove the {{@return}} statement or add detailed description for return? was (Author: nihaljain.cs): I also felt the same, just copied the way {{getRequestUser()}} was doing it. Should I remove the {{@return}} statement or also add detailed description for return. > Correct java-doc for the method RpcServer.getRemoteAddress() > ------------------------------------------------------------ > > Key: HBASE-21243 > URL: https://issues.apache.org/jira/browse/HBASE-21243 > Project: HBase > Issue Type: Improvement > Affects Versions: 3.0.0, 2.0.0 > Reporter: Nihal Jain > Assignee: Nihal Jain > Priority: Trivial > Labels: beginner, beginners, documentaion > Fix For: 3.0.0 > > Attachments: HBASE-21243.master.001.patch > > > Correct the java-doc for the method {{RpcServer.getRemoteAddress()}}. > Currently it look like as below: > {code:java} > /** > * @return Address of remote client if a request is ongoing, else null > */ > public static Optional<InetAddress> getRemoteAddress() { > return getCurrentCall().map(RpcCall::getRemoteAddress); > } > {code} > Contrary to the doc the method will never return null. Rather it may return > an empty Optional. -- This message was sent by Atlassian JIRA (v7.6.3#76005)