#17432: some badly formatted doc in cluster stuff
-------------------------+-------------------------------------------------
Reporter: | Owner:
chapoton | Status: needs_work
Type: | Milestone: sage-6.5
enhancement | Resolution:
Priority: major | Merged in:
Component: | Reviewers:
combinatorics | Work issues:
Keywords: | Commit:
quiver, doc | 0311b867b41b608c35d95efdf885caa1b220b11e
Authors: | Stopgaps:
Frédéric Chapoton |
Report Upstream: N/A |
Branch: |
u/chapoton/17432 |
Dependencies: |
-------------------------+-------------------------------------------------
Changes (by aapitzsch):
* status: needs_review => needs_work
Comment:
Your description of the function needs work.
> It prescribes the function or method’s effect as a command (“Do this”,
“Return that”), not as a description; e.g. don’t write “Returns the string
representation ...”. [0]
Could you add a few more line breaks to respect {{{<= 72}}} characters per
line for docstrings (where possible). [1]
[0] [http://www.sagemath.org/doc/developer/coding_basics.html#docstring-
markup-with-rest-and-sphinx]
[1] [http://legacy.python.org/dev/peps/pep-0008/#maximum-line-length]
--
Ticket URL: <http://trac.sagemath.org/ticket/17432#comment:2>
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.
