#19067: Incomplete sentences in the automatically generated documentation
-------------------------+-------------------------------------------------
Reporter: | Owner:
ncohen | Status: positive_review
Type: | Milestone: sage-6.9
enhancement | Resolution:
Priority: major | Merged in:
Component: | Reviewers: Marc Mezzarobba
documentation | Work issues:
Keywords: | Commit:
Authors: | 3728de720c632a5dabc09824000e6818c5716274
Nathann Cohen | Stopgaps:
Report Upstream: N/A |
Branch: |
u/ncohen/19067 |
Dependencies: |
-------------------------+-------------------------------------------------
Changes (by ncohen):
* cc: jsrn (added)
Comment:
That came from a `\\` instead of `\` in `coding/guava.py`.
The thing is that the docstrings of the code constructors do not respect
the convention that the first line must be a short sentence describing the
function, and as a result the first paragraph contains a *LOT* of text
(including some latex).
Previously, only one (broken) sentence was displayed in the index. At
least now the "sentence" is complete.
Nathann
--
Ticket URL: <http://trac.sagemath.org/ticket/19067#comment:30>
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.
