#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):
Meanwhile it looks a bit better. I think the key is to treat a class and
and instance of that class in the same way when determining the docstring.
Now, I return the doc of `obj.__init__` if the docstring of `obj` is empty
after stripping signature and embedding. Before, I only did so if `obj` is
a class. Problem: The doc builder removes duplicates, and thus it will
only document a class instance in addition to the class if it has its
''own'' docstring. Hence, docstrings of classes and instances must be
treated equal.
--
Ticket URL: <http://trac.sagemath.org/ticket/17847#comment:74>
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.
