[
https://issues.apache.org/jira/browse/HDFS-4352?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13547460#comment-13547460
]
Suresh Srinivas commented on HDFS-4352:
---------------------------------------
Todd, can you please wait for +1 from jenkins before committing a patch? Please
see the javadoc warnings comment above.
Few more comments:
{code}
- * @return New BlockReader instance, or null on error.
+ * @param params The parameters
+ *
+ * @return New BlockReader instance
{code}
Why make this document change. Isn't previous @return documented better than
the new one?
# The earlier version of the code documented each of the parameter. Now all the
document is removed. There is no documentation of params members.
MiniDFSCluster has nice documentation for a similar code for the Builder class.
# All this said, I have hard time understanding why this is a good code change.
This kind of change was made earlier when we had a lot of variants of a method
with different parameter combination. That is not the case here. I agree with
Nicholas that this does not add much value, in fact makes the code less clear.
> Encapsulate arguments to BlockReaderFactory in a class
> ------------------------------------------------------
>
> Key: HDFS-4352
> URL: https://issues.apache.org/jira/browse/HDFS-4352
> Project: Hadoop HDFS
> Issue Type: Sub-task
> Components: hdfs-client
> Affects Versions: 2.0.3-alpha
> Reporter: Colin Patrick McCabe
> Assignee: Colin Patrick McCabe
> Fix For: 3.0.0
>
> Attachments: 01b.patch, 01.patch
>
>
> Encapsulate the arguments to BlockReaderFactory in a class to avoid having to
> pass around 10+ arguments to a few different functions.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
