[
https://issues.apache.org/jira/browse/NUMBERS-70?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16808775#comment-16808775
]
Gilles commented on NUMBERS-70:
-------------------------------
{code:java}
import org.apache.commons.numbers.angle.PlaneAngle
import org.apache.commons.numbers.angle.PlaneAngleRadians
public double To_Angle{
private static final double to_radians = 2 * Math.PI;
public double Radians(double value) {
return value * to_radians;
}
}
{code}
Did you compile the above code?
Documentation should certainly not show examples that contradict conventions
used by the project (Java programmers are used to the "Camel case" syntax with
identifiers starting with a lowercase letter).
Again, you seem to show an alternative implementation of a functionality which
the library readily provides; if a user would want to convert an angle given in
degrees to its value in radians, here is the code he'd use:
{code:java}
import org.apache.commons.numbers.angle.PlaneAngle;
final double angleDeg = 180;
final double angleRad = PlaneAngle.ofDegrees(angleDeg).toRadians();
{code}
Even so, the purpose your code is not obvious (as it misses comment and/or
Javadoc): You don't specify what it is that we convert from (turns (?)).
{quote}How can i share my proposal with you ?
{quote}
Do you mean a GSoC proposal?
If so, we are not yet at that point: Contributing documentation cannot require
someone to correct almost every line you write; in the latest patch, I count
largely more than 10 errors (English syntax and spelling, xdoc syntax, Java
code syntax and formatting).
If you'd like to contribute, I'd suggest that you try something else, more
"coding-oriented".
> 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
>
> Attachments: 0001-Angles-xdoc-is-added.patch,
> 0001-Prime-xdoc-file-is-added.patch, 0001-Primes-xdoc-is-added.patch
>
>
> 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)
