I assume that all sage source files which have not yet been converted
to the new ReST format should go through that process, and soon, for
the following reasons at least:

(1) Sage currently has two different conventions for docstring format
simultaneously, which is stupid and offputting to new contributers.

(2) There are lots of files which do not currently show up in the
reference manual, while presumable they all should (bar some
exceptions such as all.py files and maybe some others).  The pdf
version is only 2795 pages long!

Therefore (if I am right)  there needs to be a planned procedure for
completing the ReSTification of Sage.  For a start, is there anywhere
a list showing which files have not yet been converted?

To get people involved with actually doing the work, perhaps a docday
would be appropriate?  They (we) would need step-by-step instructions,
links to ReST documentation, optional conversion scripts, clear
instructions on how to test whether your edited docstrings actually
look the way they should in both html in pdf formats, and also
instructions on how to get files included in the reference manual
which are not already there.

It may be that this is not a big a problem overall as it seems to me
to be, given that most of my time is take up in
sage/rings/number_fields and sage/schemes/elliptic_curves.

John

--~--~---------~--~----~------------~-------~--~----~
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to 
[email protected]
For more options, visit this group at http://groups.google.com/group/sage-devel
URLs: http://www.sagemath.org
-~----------~----~----~----~------~----~------~--~---

Reply via email to