[jira] [Commented] (NUMBERS-194) JavaDoc change - coprimes check in ArithmeticUtils::gcd

["Gilles Sadowski (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/NUMBERS-194?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17742913#comment-17742913 ] 

Gilles Sadowski commented on NUMBERS-194:
-----------------------------------------

[~dimitrios.efthymiou],

Please use the following format for the first line of the commit message: "<report id>: <summary>."

I.e. for this issue, the commit message could be something like
{noformat}
NUMBERS-194: Javadoc.

Explain how to determine whether two numbers are relative primes ("coprime").
{noformat}

Of course, you can add more details below the first line, but that *first line is a summary* (all words akin to "something has changed" are redundant and are preferably left out).


> JavaDoc change - coprimes check in ArithmeticUtils::gcd
> -------------------------------------------------------
>
>                 Key: NUMBERS-194
>                 URL: https://issues.apache.org/jira/browse/NUMBERS-194
>             Project: Commons Numbers
>          Issue Type: New Feature
>          Components: primes
>            Reporter: Dimitrios Efthymiou
>            Priority: Minor
>              Labels: features
>   Original Estimate: 1h
>  Remaining Estimate: 1h
>
> I am proposing a JavaDoc addition to ArithmeticUtils::gcd that mentions that GCD can be used to check 2 integers are coprime. This was [~aherbert] idea.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)