#7549: Reference manual: class hierarchy, inherited members, underscore
variables
-----------------------------+----------------------------------------------
Reporter: mpatel | Owner: mvngu
Type: enhancement | Status: needs_work
Priority: minor | Milestone:
Component: documentation | Keywords:
Author: Mitesh Patel | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
Changes (by jhpalmieri):
* status: needs_review => needs_work
Comment:
If I run {{{sage -docbuild reference html -i}}}, I get
{{{
reading sources... [ 8%] sage/algebras/iwahori_hecke_algebra_element
Exception occurred:
File "/Applications/sage/devel/sage/doc/common/conf.py", line 354, in
skip_member
if 'SAGE_CHECK_NESTED' in os.environ:
RuntimeError: maximum recursion depth exceeded
The full traceback has been saved in ...
}}}
I scanned the traceback but didn't see anything obviously helpful.
By the way, I think we can put back the doctest from
interfaces/singular.py, by changing the triple quotes at the beginning of
the docstring to {{{r"""}}}. The attached patch does this.
Also, I used all of the extra error messages to figure out where the
warnings
{{{
<autodoc>:0: (ERROR/3) Unexpected indentation.
}}}
were coming from, and the attached patch fixes the problems. So now,
combined with #8457, I get no error messages when building the reference
manual (without the -i or -u switches, of course).
For the new warnings when building with -i or -u or -iu, I say we deal
with them on another ticket. It's a big job revising all of the
docstrings for underscore functions so that they are in proper reST
format. (Also, right now they're useful -- see the previous paragraph. :)
Finally, do we want some sort of warning for the -i switch, and possibly
the -u switch? ("may be slow, may not be compatible with PDF output" as
part of its help string, for example)?
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/7549#comment:28>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
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.
