commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Gilles (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (MATH-1023) Javadoc in "SummaryStatistics" ("o.a.c.m.stat.descriptive")
Date Wed, 04 Sep 2013 06:13:51 GMT

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

Gilles commented on MATH-1023:
------------------------------

bq. it must be activated before any data has been added - i.e., before any calls to addValue.

When I read that, I assume that the call is part of the initialization, and that "addValue"
will fail if I have not called "setXxxxImpl". This is harmless, as people who read the doc
will just write unnecessary code... (I wrote the code before, and observed that it didn't
raise as the doc would seem to imply). Simply adding your explanation above would clarify
a lot IMO.

                
> Javadoc in "SummaryStatistics" ("o.a.c.m.stat.descriptive")
> -----------------------------------------------------------
>
>                 Key: MATH-1023
>                 URL: https://issues.apache.org/jira/browse/MATH-1023
>             Project: Commons Math
>          Issue Type: Improvement
>    Affects Versions: 3.2
>            Reporter: Gilles
>            Priority: Trivial
>              Labels: documentation
>
> The documentation for methods "set...Impl(...)" indicates:
> ---
> This method must be activated before any data has been added - i.e., before addValue
has been used to add data; otherwise an IllegalStateException will be thrown.
> ---
> However, every instance is created with default implementations; the warning is thus
obsolete.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message