#17847: Cython: embed signatures in docstrings of Sage library code
-------------------------------------+-------------------------------------
Reporter: jdemeyer | Owner:
Type: enhancement | Status: new
Priority: major | Milestone: sage-6.6
Component: cython | Resolution:
Keywords: | Merged in:
Authors: Jeroen Demeyer, | Reviewers: Simon King
Simon King | Work issues:
Report Upstream: Fixed upstream, | Commit:
but not in a stable release. | 104837abe3c6d5e0204f4d0ffa49293f14f885d6
Branch: | Stopgaps:
u/jdemeyer/ticket/17847 |
Dependencies: |
-------------------------------------+-------------------------------------
Comment (by SimonKing):
`make doc` still fails. I see several errors.
One error looks like this:
{{{
[combinat ] /home/king/Sage/git/sage/local/lib/python2.7/site-
packages/sage/combinat/__init__.py:docstring of sage.combinat:39: WARNING:
undefined label: sage.coding (if the link has no caption the label must
precede a section header)
}}}
No idea what that means.
Another error:
{{{
[finite_ri] docstring of
sage.rings.finite_rings.finite_field_base.FiniteField.algebraic_closure:1:
WARNING: Inline strong start-string without end-string.
}}}
That again seems like a failing removal of `**kwds` from the signature, or
similar problems.
Indeed:
{{{
sage: print
sage_getdoc_original(sage.rings.finite_rings.finite_field_base.FiniteField.algebraic_closure)
FiniteField.algebraic_closure(self, name='z', **kwds)
File: sage/rings/finite_rings/finite_field_base.pyx (starting at line
1278)
Return an algebraic closure of ``self``.
INPUT:
...
}}}
So, although `sage_getdoc_original` is supposed to strip the embedding
information, it doesn't!
You are right, it seems to be a problem with cached methods.
--
Ticket URL: <http://trac.sagemath.org/ticket/17847#comment:54>
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 unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
