MASON-INTEREST-L Archives

May 2011

MASON-INTEREST-L@LISTSERV.GMU.EDU

Options: Use Monospaced Font
Show HTML Part by Default
Show All Mail Headers

Message: [<< First] [< Prev] [Next >] [Last >>]
Topic: [<< First] [< Prev] [Next >] [Last >>]
Author: [<< First] [< Prev] [Next >] [Last >>]

Print Reply
Subject:
From:
Ben Stabile <[log in to unmask]>
Reply To:
MASON Multiagent Simulation Toolkit <[log in to unmask]>
Date:
Wed, 11 May 2011 09:41:01 -0400
Content-Type:
multipart/alternative
Parts/Attachments:
text/plain (896 bytes) , text/html (1273 bytes)
I've been going over the "sim.util.distribution" implementations and I've
noticed that the code comments (JavaDoc) has several inconsistencies. I know
that the online docs don't include these comments (yet?),  but if you DO
generate the docs someone should review the descriptions of parameter
boundaries.

For example, in ChiSquare class documentation (line 19) the following is
found:

* * Valid parameter ranges: <tt>freedom &gt; 0</tt>.
*
In fact, the parameter must be *greater than or equal to* *1.0* or an
ArgumentException will be thrown in "*setState(double freedom)*" (line 142).

Other inconsistencies exist elsewhere, but I'm just pointing this one out so
you can be aware that a thorough review should be conducted if you plan on
publishing the class docs for these distributions. Otherwise, you could end
up with quite a flurry of newsgroup queries, or worse, a lot of broken code.
*;-)*

Regards,

Ben S.


ATOM RSS1 RSS2