Mailing-List: contact issues-help@commons.apache.org; run by ezmlm
Precedence: bulk
Reply-To: issues@commons.apache.org
Date: Sat, 24 Sep 2011 04:17:26 +0000 (UTC)
From: =?utf-8?Q?S=C3=A9bastien_Brisard_=28JIRA=29?= <jira@apache.org>
To: issues@commons.apache.org
Message-ID: 
 <1788452686.8703.1316837846997.JavaMail.tomcat@hel.zones.apache.org>
In-Reply-To: 
 <1466447595.50820.1316616189252.JavaMail.tomcat@hel.zones.apache.org>
Subject: [jira] [Commented] (MATH-674) Too much documentation in
 "UnivariateRealFunction.java"?
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable


    [ https://issues.apache.org/jira/browse/MATH-674?page=3Dcom.atlassian.j=
ira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=3D131138=
91#comment-13113891 ]=20

S=C3=A9bastien Brisard commented on MATH-674:
----------------------------------------

Got it. Sorry about that,
S=C3=A9bastien

> Too much documentation in "UnivariateRealFunction.java"?
> --------------------------------------------------------
>
>                 Key: MATH-674
>                 URL: https://issues.apache.org/jira/browse/MATH-674
>             Project: Commons Math
>          Issue Type: Improvement
>            Reporter: Gilles
>            Priority: Trivial
>              Labels: documentation
>             Fix For: 3.0
>
>
> I noticed that because they inherit the Javadoc for "UnivariateRealFuncti=
on", all functions in package "o.a.c.m.analysis.function" have their "value=
" method contain a fairly large amount of documentation that is related to =
a marginal issue (advice about why and when a user would need to implement =
his own exceptions for his own functions) _that does not apply to the funct=
ion being documented_.
> It might be confusing to have that documentation appear there (i.e. in a =
place where none of the functions are defined by the user). It should proba=
bly be moved elsewhere (user guide).

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira