#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. | 21ecfada11dda015de204cb92c27916e561c726a
Branch: | Stopgaps:
u/jdemeyer/ticket/17847 |
Dependencies: |
-------------------------------------+-------------------------------------
Comment (by SimonKing):
Replying to [comment:47 jdemeyer]:
> Replying to [comment:46 SimonKing]:
> > Or is `_sage_getdoc_unformatted` used to build the docs?
>
> That's certainly the intention of `src/doc/common/sage_autodoc.py`
Thanks! Shouldn't sage_getdoc be used instead? Anyway, the embedded
information does in my opinion not belong into the reference manual.
Hence, it needs to be stripped one way or another. And if sage_autodoc has
a custom way of stripping, then either the custom way should be changed to
take into account the new embedded signature, or it should use a
specialised tool (namely sage_getdoc) right away.
--
Ticket URL: <http://trac.sagemath.org/ticket/17847#comment:48>
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.
