#13907: Fix docstrings in sage/ext/fast_eval.pyx
-------------------------------------+-------------------------------------
Reporter: ppurka | Owner: mvngu
Type: defect | Status: needs_work
Priority: major | Milestone: sage-6.2
Component: documentation | Resolution:
Keywords: beginner, days57 | Merged in:
Authors: | Reviewers:
Report Upstream: N/A | Work issues:
Branch: | Commit:
u/Fougeroc/Fix_docstrings_in_fast_eval.pyx|
4852acdb0032c5625efd8de1aa7ad701196f4f92
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Changes (by vdelecroix):
* keywords: beginner => beginner, days57
* status: needs_review => needs_work
Comment:
For string formatting, you should look at the developer's guide
http://www.sagemath.org/doc/developer/coding_basics.html#docstring-markup-
with-rest-and-sphinx
Comments:
- remove trailing whitespaces (line 27, 42, ...)
- the docstring at the begining of the file should not be indented
- NOTE, AUTHOR field is not appropriately formated
- in `_richcmp_` (line 928), you should add a linebreak between the
description
"Compare left and right." and the beginig of the examples
More to come at your next commit...
--
Ticket URL: <http://trac.sagemath.org/ticket/13907#comment:10>
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.
