Opened 5 years ago
Last modified 5 years ago
#22611 closed enhancement
Replace _sage_doc_ by a __doc__ descriptor — at Initial Version
Reported by: | jdemeyer | Owned by: | |
---|---|---|---|
Priority: | major | Milestone: | sage-7.6 |
Component: | documentation | Keywords: | days85 |
Cc: | hivert, nthiery | Merged in: | |
Authors: | Jeroen Demeyer | Reviewers: | |
Report Upstream: | N/A | Work issues: | |
Branch: | Commit: | ||
Dependencies: | Stopgaps: |
Description
The method _sage_doc_
is used to have custom documentation for instances of a class. Such a use case makes sense, but it should be implemented as the __doc__
attribute instead of the Sage-specific _sage_doc_
.
This is easy for Python classes, but it might be problematic for cdef class
es.
Note: See
TracTickets for help on using
tickets.