#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:65 SimonKing]:
> I'd suggest that the signature should not be inserted. There is no
reason to insert the signature of `Parent.__init__` into `Parent.__doc__`,
since the same signature is also inserted into `Parent.__init__.__doc__`,
where it belongs.
>
> When we will be using the inserted signature in a new version of
`sage_getargspec`, we will be considering `__init__` anyway when it is
used on a class.
>
> I'll try to figure out how it works.
Hm. `__init__` is not explicitly considered in your patch. So, I can't
figure out what needs to be done.
Do we have a possibility to convince Cython to either not use
`Foo.__init__` for inserting the signature into `Foo.__doc__`, or to add
the embedding information in addition to the signature into `Foo.__doc__`?
--
Ticket URL: <http://trac.sagemath.org/ticket/17847#comment:67>
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.
