#17847: Cython: embed signatures in docstrings
-------------------------------------+-------------------------------------
Reporter: jdemeyer | Owner:
Type: enhancement | Status: new
Priority: major | Milestone: sage-6.6
Component: cython | Resolution:
Keywords: | Merged in:
Authors: Jeroen Demeyer | Reviewers:
Report Upstream: Fixed upstream, | Work issues:
but not in a stable release. | Commit:
Branch: | 1a36cc96d1e9ebd5d46a3dd9c027a41e89da2ebc
u/jdemeyer/ticket/17847 | Stopgaps:
Dependencies: |
-------------------------------------+-------------------------------------
Comment (by SimonKing):
... and that's on purpose, according to the documentation of
`_sage_getdoc_unformatted`:
{{{
If ``__init__`` has embedding information, we prefer that::
sage: C = QQ['x', 'y'].__class__
sage: print C.__doc__
MPolynomialRing_libsingular(base_ring, n, names,
order='degrevlex')
sage: print C.__init__.__doc__
File: sage/rings/polynomial/multi_polynomial_libsingular.pyx
(starting at line ...)
<BLANKLINE>
Construct a multivariate polynomial ring...
sage: print _sage_getdoc_unformatted(C)
File: sage/rings/polynomial/multi_polynomial_libsingular.pyx
(starting at line ...)
<BLANKLINE>
Construct a multivariate polynomial ring...
}}}
Thus, `_sage_getdoc_unformatted` is the wrong tool for our purpose, since
we do ''not'' want to prefer the doc of `__init__`.
Also: What happens if a class derived from `Parent` has no docstring?
--
Ticket URL: <http://trac.sagemath.org/ticket/17847#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 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.
