Issue 133 in ellipsoids: Create a separate section in the ellipsoidal toolbox manual that covers functionality of classes within gras.ellapx.smartdb.rels package

[ellip...@googlecode.com]

Status: New
Owner: anna.ata...@gmail.com
Labels: Type-Enhancement

New issue 133 by heartofm...@gmail.com: Create a separate section in the
ellipsoidal toolbox manual that covers functionality of classes within
gras.ellapx.smartdb.rels package
http://code.google.com/p/ellipsoids/issues/detail?id=133

gras.ellapx.smartdb.rels package contains classes for representing
ellipsoidal tubes. These classes are covered in the manual very poorly.

You need to

1) For every method of these classes described in the manual excluding the
methods inherited from ARelation class write a usage example for every
sensible combinations of inputs. You can easily see in the manual which
methods are inherited and which are not. Another way to see that is to
check whether a method's code is located in gras.ellapx.smartdb.rels
package, if it is not - you do not need to describe this method.

For instance if method X can be called in 2 different ways you need to
create 2 examples or an example that covers both ways.

All the examples should be placed into gras.ellapx.smartdb.test.examples
package and called from a test written in
gras.ellapx.smartdb.test.mlunit.ExamplesTC test case.
gras.ellapx.smartdb.test.run_tests function needs to be modified to call
this test.


2) Write a separate chapter (as chap_elltube.tex file) from which you need
to import every example using a special \verbmcodef Latex environment (see
its usage in chap_examples.tex). Every example should explain in good
english with detailed comments.

For compiling the manual please use Miktex 2.9 and PDFTexify




--
You received this message because this project is configured to send all
issue notifications to this address.
You may adjust your notification preferences at:
https://code.google.com/hosting/settings

[ellip...@googlecode.com]

Comment #1 on issue 133 by heartofm...@gmail.com: Create a separate section

in the ellipsoidal toolbox manual that covers functionality of classes
within gras.ellapx.smartdb.rels package
http://code.google.com/p/ellipsoids/issues/detail?id=133

3) Document the methods for which you wrote the examples in 1) in help
headers of these methods. Current help headers are either incorrect or out
of date.

[ellip...@googlecode.com]

Updates:
Status: ReadyForReview

Comment #2 on issue 133 by anna.ata...@gmail.com: Create a separate section

in the ellipsoidal toolbox manual that covers functionality of classes
within gras.ellapx.smartdb.rels package
http://code.google.com/p/ellipsoids/issues/detail?id=133

(No comment was entered for this change.)