[
https://issues.apache.org/jira/browse/ACCUMULO-279?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13181511#comment-13181511
]
Keith Turner commented on ACCUMULO-279:
---------------------------------------
Javadoc supports package level documentation. Could use that format and
filenaming convention if we put the info in the READMEs in the src dir.
> Add descriptions to README.mapred
> ---------------------------------
>
> Key: ACCUMULO-279
> URL: https://issues.apache.org/jira/browse/ACCUMULO-279
> Project: Accumulo
> Issue Type: Improvement
> Components: docs
> Reporter: David Medinets
> Assignee: Adam Fuchs
> Priority: Trivial
>
> I think the following files have no descriptions associated with them.
> {noformat}
> src/main/java/org/apache/accumulo/examples/mapreduce/RegexExample.java
> src/main/java/org/apache/accumulo/examples/mapreduce/RowHash.java
> src/main/java/org/apache/accumulo/examples/mapreduce/TableToFile.java
> src/main/java/org/apache/accumulo/examples/mapreduce/TeraSortIngest.java
> {noformat}
> And while I'm thinking about it, since each examples directory corresponds to
> a readme file perhaps the readme file should be in the source directory to
> improve locality? And should examples/mapreduce/bulk be one level up at
> /examples/bulk, again, because those classes have their own readme file.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
