Opened 4 years ago

Last modified 4 years ago

#22611 closed enhancement

Replace _sage_doc_ by a __doc__ descriptor — at Version 3

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: u/jdemeyer/ticket/22611 (Commits, GitHub, GitLab) Commit: 326465738e5a563ebffc86196f400829650cee63
Dependencies: Stopgaps:

Status badges

Description (last modified by jdemeyer)

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_.

I tried various ways of implementing this and I was various Cython bugs along the way. The current solution is not the cleanest, but it works in all cases.

Change History (3)

comment:1 Changed 4 years ago by jdemeyer

  • Description modified (diff)
  • Keywords days85 added

comment:2 Changed 4 years ago by jdemeyer

  • Branch set to u/jdemeyer/ticket/22611

comment:3 Changed 4 years ago by jdemeyer

  • Cc hivert nthiery added
  • Commit set to 326465738e5a563ebffc86196f400829650cee63
  • Description modified (diff)
  • Status changed from new to needs_review

New commits:

3264657Replace _sage_doc_ by a __doc__ descriptor
Note: See TracTickets for help on using tickets.