[
https://issues.apache.org/jira/browse/MATH-851?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13439392#comment-13439392
]
Gilles commented on MATH-851:
-----------------------------
bq. [...] although this is not required in CM, I personally try to comply as
much as possible with this document: for example, description of arguments
should begin with "the", no capital letter, and should not end with '.' [...]
Personally, I don't like this convention because it makes for inconsistent
style when there is more than one sentence in the description of the parameter:
According to the above, there won't be an uppercase letter to start the first
sentencen but there will be one to start the second (according to the rules for
writing any document). Also, I do _not_ start the sentence with "the" (with or
without uppercase) when the comment is just a short/trivial description (in
which case "the" just lengthens the text).
But I _do_ begin the description of the "@return" tag with lowercase "the"
(because the generated HTML starts that section with "Returns:").
> Add convolution
> ---------------
>
> Key: MATH-851
> URL: https://issues.apache.org/jira/browse/MATH-851
> Project: Commons Math
> Issue Type: New Feature
> Reporter: Clemens Novak
> Priority: Minor
> Attachments: Filter.java, FilterTest.java, FilterUtils.java,
> FilterUtilsTest.java
>
>
> I created a function performing (one-dimensional) convolution. Currently, the
> function is in a class called Filter, but I am not sure whether this is the
> appropriate place for it(?).
--
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
