#6840: [with patch, needs work]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:
Merged: |
----------------------+-----------------------------------------------------
Comment(by mvngu):
The patch `trac_6840-notebook-documentation-v4.patch` applies OK against
4.1.1, but with one fuzz:
{{{
[mv...@sage sage-main]$ hg qimport http://trac.sagemath.org/sage_trac/raw-
attachment/ticket/6840/trac_6840-notebook-documentation-v4.patch && hg
qpush
adding trac_6840-notebook-documentation-v4.patch to series file
applying trac_6840-notebook-documentation-v4.patch
patching file sage/server/notebook/config.py
Hunk #1 succeeded at 1 with fuzz 1 (offset -1 lines).
Now at: trac_6840-notebook-documentation-v4.patch
}}}
Building the reference manual results in about 10 warnings:
{{{
WARNING: /scratch/mvngu/release/sage-4.1.1/local/lib/python2.6/site-
packages/sage/server/notebook/cell.py:docstring of
sage.server.notebook.cell.Cell.html:8: (WARNING/2) Inline literal start-
string without end-string.
WARNING: /scratch/mvngu/release/sage-4.1.1/local/lib/python2.6/site-
packages/sage/server/notebook/cell.py:docstring of
sage.server.notebook.cell.Cell.html_out:6: (WARNING/2) Bullet list ends
without a blank line; unexpected unindent.
WARNING: /scratch/mvngu/release/sage-4.1.1/local/lib/python2.6/site-
packages/sage/server/notebook/cell.py:docstring of
sage.server.notebook.cell.Cell.is_interacting:8: (WARNING/2) Block quote
ends without a blank line; unexpected unindent.
WARNING: /scratch/mvngu/release/sage-4.1.1/local/lib/python2.6/site-
packages/sage/server/notebook/cell.py:docstring of
sage.server.notebook.cell.Cell.output_text:10: (WARNING/2) Bullet list
ends without a blank line; unexpected unindent.
WARNING: /scratch/mvngu/release/sage-4.1.1/local/lib/python2.6/site-
packages/sage/server/notebook/cell.py:docstring of
sage.server.notebook.cell.Cell.parse_html:15: (WARNING/2) Block quote ends
without a blank line; unexpected unindent.
WARNING: /scratch/mvngu/release/sage-4.1.1/local/lib/python2.6/site-
packages/sage/server/notebook/cell.py:docstring of
sage.server.notebook.cell.ComputeCell.html:8: (WARNING/2) Inline literal
start-string without end-string.
WARNING: /scratch/mvngu/release/sage-4.1.1/local/lib/python2.6/site-
packages/sage/server/notebook/cell.py:docstring of
sage.server.notebook.cell.ComputeCell.html_out:6: (WARNING/2) Bullet list
ends without a blank line; unexpected unindent.
WARNING: /scratch/mvngu/release/sage-4.1.1/local/lib/python2.6/site-
packages/sage/server/notebook/cell.py:docstring of
sage.server.notebook.cell.ComputeCell.is_interacting:8: (WARNING/2) Block
quote ends without a blank line; unexpected unindent.
WARNING: /scratch/mvngu/release/sage-4.1.1/local/lib/python2.6/site-
packages/sage/server/notebook/cell.py:docstring of
sage.server.notebook.cell.ComputeCell.output_text:10: (WARNING/2) Bullet
list ends without a blank line; unexpected unindent.
WARNING: /scratch/mvngu/release/sage-4.1.1/local/lib/python2.6/site-
packages/sage/server/notebook/cell.py:docstring of
sage.server.notebook.cell.ComputeCell.parse_html:15: (WARNING/2) Block
quote ends without a blank line; unexpected unindent.
}}}
The test suite reports one doctest failure:
{{{
sage -t -long devel/sage-main/sage/server/notebook/cell.py
**********************************************************************
File "/scratch/mvngu/release/sage-4.1.1/devel/sage-
main/sage/server/notebook/cell.py", line 1598:
sage: C.introspect_html()
Expected:
'<div class="docstring">\n \n <p><span
class="math">foobar</span></p>\n\n\n</div>'
Got:
'<div class="docstring">\n \n \n <p><span
class="math">foobar</span></p>\n\n\n</div>'
**********************************************************************
1 items had failures:
1 of 13 in __main__.example_71
***Test Failed*** 1 failures.
For whitespace errors, see the file
/scratch/mvngu/release/sage-4.1.1/tmp/.doctest_cell.py
[26.4 s]
}}}
I'm marking this as "needs work", since at least the doctest failure must
be resolved. The warnings from building the reference manual can be
addressed via another ticket. However, it would be nice if both of these
issues could be fixed here.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/6840#comment:8>
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
-~----------~----~----~----~------~----~------~--~---
