commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Phil Steitz <>
Subject Re: [math] Documentation
Date Sat, 10 Sep 2011 15:50:32 GMT
On 9/9/11 10:19 PM, Greg Sterijevski wrote:
> Okay, I have begun nibbling on the doc. I will push a few changes I made in
> connection to doing no intercept regression in SimpleRegression.

Great!  I usually now fail at this, but I used to try to bundle all
of the following in commits that change or extend functionality:

0) atomic set of code changes associated with the feature (meaning,
just the changes for the feature)
1) update to changes.xml
2) update to user guide

This is kind of aspirational and all that really matter is that 1)
and 2) happen before release.  A good reason to postpone them is if
0) may be followed by a bunch more changes before the API stabilizes
and you don't want to suffer the pain of editing xdoc more than once
:)  In those cases, its best to leave the JIRA ticket open with a
comment saying user guide needs to be updated so we don't forget.

> On Sun, Aug 28, 2011 at 10:17 PM, Phil Steitz <> wrote:
>> On 8/28/11 7:24 PM, Greg Sterijevski wrote:
>>> Hello All,
>>> What tool is used to create the documentation (if one is used at all)?
>>> Specifically, I am looking in commons-math/src/site/xdoc/userguide
>>> If I wanted to add to the regression portion of stat.xml what is the best
>>> way to accomplish this (use vi or some wysiwyg editor)?
>> There is no better tool than vi.  We don't allow emacs or anyone who
>> uses that (sorry, Luc).
>> Just kidding.  The xml files in the directory above are turned into
>> the user guide you see on the web pages by maven's site plugin.  If
>> you run "mvn site" from the command line at the top level of a
>> checkout of trunk or any branch or tag, the full site, including the
>> user guide, will be generated in the target/site directory.  You can
>> use any text editor to edit the files.  Just imitate the format of
>> what is there and maven will be able to eat what you add.  Remember
>> to set the svn properties on any new files that you add.  This will
>> happen automatically if you use [1].  Many thanks for helping out on
>> the User Guide.
>> Phil
>> [1]
>>> Thank you,
>>> -Greg
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail:
>> For additional commands, e-mail:

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message