#6109: [with patch, needs review] Bring documentation for QQbar up to 100% and
add
to reference manual
---------------------+------------------------------------------------------
Reporter: cremona | Owner: tbd
Type: defect | Status: new
Priority: major | Milestone: sage-4.0.1
Component: algebra | Keywords: QQbar documentation
---------------------+------------------------------------------------------
Comment(by cremona):
The first patch converts the docstrings to ReST and put the file into the
reference manual, so it looks ok. Still to do:
1. Reformat the docstrongs which do exist into standard layout (with
INPUT/OUTPUT blocks etc)
2. Add docstrings for 162 functions which do not yet have them (!)
3. Add doctests to those and the few function which have docstrings
but no doctests.
I have taken the liberty of adding "needs review" already despite not
having increased the coverage at all yet, since I do actually believe that
this should go in already. there is a huge amount of very useful code
here which deserves better publicity (as I think having it in the
reference manual will do) and there is already plenty of documentation.
Having been through this file, I can see that I should be using QQbar much
more than I have done up to now.
I am not promising to work on tasks 1-3 above i nthe near future, so if
anyone else wants to make a start they should go ahead.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/6109#comment:2>
Sage <http://sagemath.org/>
Sage - Open Source Mathematical Software: Building the Car Instead of
Reinventing the Wheel
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
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-trac?hl=en
-~----------~----~----~----~------~----~------~--~---
