#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 Delecroix | Reviewers: Nathann Cohen
Report Upstream: N/A | Work issues:
Branch: | Commit:
u/vdelecroix/19041 | 51657979296acca64c5e7b1a9b2521efe89a9bcf
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Comment (by jhpalmieri):
I agree that the `OUTPUT` block can sometimes be omitted. I've seen
docstrings that start like this:
{{{
def jones_polynomial(self):
"""
Return the Jones polynomial of this link.
OUTPUT:
- the Jones polynomial of this link
}}}
and I think we can safely omit the `OUTPUT` block in such cases.
--
Ticket URL: <http://trac.sagemath.org/ticket/19041#comment:8>
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.
