#9608: Docbuild warnings in sage/interfaces/matlab.py
-----------------------------+----------------------------------------------
Reporter: mpatel | Owner: mvngu
Type: defect | Status: positive_review
Priority: blocker | Milestone: sage-4.5.2
Component: documentation | Keywords:
Author: Mitesh Patel | Upstream: N/A
Reviewer: John Palmieri | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
Changes (by jhpalmieri):
* status: needs_review => positive_review
* reviewer: => John Palmieri
Comment:
> Hrm, doing that doesn't fix the problem -- the function then gets a
string with no newlines, but with literal "\n" bits.
Isn't that what you want? You're defining s to be a particular string,
one containing "\n" in it (to give a newline), and you want each "\n" to
appear as such in the reference manual. That is, {{{s = '\nans =\n\n
2\n'}}} is a valid way to define a python string, and it should appear
this way in the reference manual. If you want to define a string
containing actual new lines, you would have to use triple quotes, wouldn't
you?
This makes sense to me, and I've seen other docstring errors and fixes
just like this in the past. The particular docstring here looks much
better after the patch, and there are no warnings. Positive review.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9608#comment:6>
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 post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
