#19041: Better description of docstrings in the developer guide
-------------------------------------+-------------------------------------
Reporter: vdelecroix | Owner:
Type: enhancement | Status: needs_work
Priority: major | Milestone: sage-6.9
Component: documentation | Resolution:
Keywords: | Merged in:
Authors: Vincent | Reviewers: Nathann Cohen
Delecroix, Jori Mäntysalo |
Report Upstream: N/A | Work issues:
Branch: | Commit:
u/jmantysalo/19041 | d01d36d74b80e44b6676c82b5ae02247e3200e30
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Comment (by jmantysalo):
I think that there is no common view for referring to `self` in docstring:
i.e. to say "Return foo number of the xyzzy." or "Return foo number of
`self`."
Shall we try to document some common cases like functions returning a
Boolean ("Test whether..." vs. "Return `True` if...") or
`certificate`-option?
Or just close this ticket as wontfix?
--
Ticket URL: <https://trac.sagemath.org/ticket/19041#comment:39>
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 https://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
