#10624: Slashes disappear in docstrings
-------------------------------------------+--------------------------------
Reporter: novoselt | Owner: mvngu
Type: defect | Status: closed
Priority: major | Milestone:
sage-duplicate/invalid/wontfix
Component: documentation | Resolution: invalid
Keywords: notebook help docstring | Work issues:
Report Upstream: N/A | Reviewers: John Palmieri
Authors: | Merged in:
Dependencies: | Stopgaps:
-------------------------------------------+--------------------------------
Comment (by jhpalmieri):
I don't think that our proposed changes to sagenb are a good idea anymore.
Problems arise when looking at docstrings from other components of Sage;
for example, if you do `r.lm?` in the notebook, before the patch
[https://github.com/sagemath/sagenb/pull/97 here], newlines are respected,
so the examples look good. But after the patch, the whole docstring is
treated as ReST markup, and so the newlines are ignored and the examples
look bad.
So we should keep working on this (at the sagenb github site, not here),
but we need to have a better solution about when to use Sphinx and when
not to.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10624#comment:12>
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.
