#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. | 19135c15db9122693b8d8d023fe59749eb1a1d64
Branch: | Stopgaps:
u/SimonKing/ticket/17847 |
Dependencies: |
-------------------------------------+-------------------------------------
Comment (by SimonKing):
Replying to [comment:59 jdemeyer]:
> This is the reason why the docstring of `__init__` was preferred when
`__doc__` contains no embedding information:
> {{{
> sage: print sage.structure.parent.Parent.__doc__
> Parent(base=None, category=None, *, element_constructor=None, gens=None,
names=None, normalize=True, facade=None, **kwds)
> }}}
Why is that? If there is no doc string, shouldn't Cython change it so that
it consists of the signature and the embedding information? Why is the
embedding information not inserted?
--
Ticket URL: <http://trac.sagemath.org/ticket/17847#comment:63>
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.
