#6840: [with patch, needs review] Fix documentation for Sage Notebook
----------------------+-----------------------------------------------------
Reporter: timdumol | Owner: boothby
Type: defect | Status: new
Priority: minor | Milestone: sage-4.1.2
Component: notebook | Keywords: notebook documentation
Reviewer: | Author: Tim Dumol, Mitesh Patel
Merged: |
----------------------+-----------------------------------------------------
Comment(by mvngu):
Replying to [comment:13 mpatel]:
> Is it alright if we treat the "PLANNING" section near the top of
`interact.py` as "internal" documentation, at least for now? I haven't
checked that it's current and Sphinx complains copiously about it.
New reviewer patch attached. Please use that one. That should get rid of
the complaints by Sphinx.
[[BR]]
> Either way, just let me know, and I'll attach v2 of the reviewer patch,
since I found at least one more minor change to make (`2D` to `2-D`).
The updated reviewer patch also addresses this issue.
[[BR]]
> By the way, is there a reST alternative to double back-quotes that puts
the enclosed text in a fixed-width font but does not change its background
color?
I don't know.
[[BR]]
Replying to [comment:14 mpatel]:
> While I'm here I should ask whether we should put both side-effects,
including possible exceptions, ''and'' return values in `OUTPUT` sections.
Mostly, I've mentioned just the return values in `OUTPUT`. On occasion,
I've noted significant effects in the blurb at the top of a docstring.
That's a good idea. Document what works and what doesn't. I usually have a
"TESTS:" section for a method/function/class where I document exceptions
that could be raised when using that method/function/class.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/6840#comment:15>
Sage <http://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
-~----------~----~----~----~------~----~------~--~---
