[
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16805858#comment-16805858
]
Gilles commented on NUMBERS-70:
-------------------------------
A patch file should be *attached* (see the "Attachments" section near the top
of this page), not posted as a comment.
It's nice that you propose adding documentation, but to be useful for
application developers, it should contain more than one line...
The purpose is to document what can be done with the code (i.e. code snippets
showing _how_ to use the available functionality). As an example, please have a
look at [that
file|https://gitbox.apache.org/repos/asf?p=commons-rng.git;a=blob;f=commons-rng-simple/src/site/xdoc/index.xml]
(for a module of "Commons RNG").
That implies that you should
# look at what the library code can do,
# write a usage example,
# check that the example works (can be compiled and provides the expected
result).
> Userguide and reports
> ---------------------
>
> Key: NUMBERS-70
> URL: https://issues.apache.org/jira/browse/NUMBERS-70
> Project: Commons Numbers
> Issue Type: Wish
> Reporter: Gilles
> Priority: Minor
> Labels: benchmark, documentation, gsoc2019
> Fix For: 1.0
>
>
> Review contents of the component towards providing an up-to-date userguide
> and write benchmarking code for generating performance reports
> ([JMH|http://openjdk.java.net/projects/code-tools/jmh/]).
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
