#6109: [with patch, positive 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 davidloeffler):
The patch applies fine to 4.0.rc1, and qqbar.py passes doctests
(unsurprisingly, since the patch doesn't actually change any tests). The
key thing is the documentation, which complies fine except for one small
glitch:
{{{
reading sources... sage/rings/qqbar
WARNING: /home/david/sage-4.0.rc1/local/lib/python2.5/site-
packages/sage/rings/qqbar.py:docstring of sage.rings.qqbar:81: (ERROR/3)
Unexpected indentation.
}}}
I can't remotely pin down what it is that's upsetting the Sphinx parser.
If you delete the entire offending docstring -- the big one at the top of
the file -- you get the same "unexpected indentation" error message again,
but purporting to be coming from the docstring of some other random
function, and if you go through several iterations of deleting docstrings
it starts claiming that there is an unexpected indentation at line 0. This
sounds rather like a Sphinx bug to me, especially as the finished
documentation looks absolutely fine.
I agree with John that the benefits of getting QQbar into the reference
manual make it worth merging this patch now -- let's have a new ticket for
adding the missing doctests.
David
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/6109#comment:4>
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
-~----------~----~----~----~------~----~------~--~---
