#6568: [with patch, positive review] Migrate Notebook to JinjaFixed docstrings
added by patch #6568 in `notebook.py` and `worksheet.py`
------------------------------------------------+---------------------------
Reporter: timdumol | Owner: timdumol
Type: enhancement | Status: closed
Priority: major | Milestone: sage-4.1.2
Component: notebook | Resolution: fixed
Keywords: notebook, jinja, templating engine | Reviewer: William Stein
Author: Tim Joseph Dumol | Merged: Sage
4.1.2.alpha0
------------------------------------------------+---------------------------
Changes (by mvngu):
* status: assigned => closed
* reviewer: => William Stein
* resolution: => fixed
* merged: => Sage 4.1.2.alpha0
Comment:
The patch `trac_6568-jinja_migration_v2.patch` results in over 20 warnings
when building the reference manual:
{{{
WARNING: /scratch/mvngu/release/sage-4.1.1/local/lib/python2.6/site-
packages/sage/server/notebook/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html:20: (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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_beforepublish_window:14:
(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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_beforepublish_window:19:
(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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_debug_window:8: (WARNING/2)
Literal block expected; none found.
WARNING: <autodoc>:0: (ERROR/3) Unexpected indentation.
WARNING: /scratch/mvngu/release/sage-4.1.1/local/lib/python2.6/site-
packages/sage/server/notebook/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.DIR:1: (ERROR/3) Unexpected
indentation.
WARNING: /scratch/mvngu/release/sage-4.1.1/local/lib/python2.6/site-
packages/sage/server/notebook/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_debug_window: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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_doc: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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_doc:17: (WARNING/2) Definition
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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_download_or_delete_datafile:17:
(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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_download_or_delete_datafile:25:
(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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_plain_text_window:18:
(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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_plain_text_window:24:
(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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_share:16: (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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_share:24: (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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_upload_data_window:13:
(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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_upload_data_window:18:
(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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_worksheet_revision_list:16:
(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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_worksheet_revision_list:23:
(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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_worksheet_settings:13:
(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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.html_worksheet_settings:20:
(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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.worksheet_html:16: (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/notebook.py:docstring of
sage.server.notebook.notebook.Notebook.worksheet_html:23: (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/worksheet.py:docstring of
sage.server.notebook.worksheet.Worksheet.html_menu:10: (WARNING/2) Block
quote ends without a blank line; unexpected unindent.
}}}
When I ran the test suite with the patch, I received a timed out error:
{{{
sage -t -long devel/sage-main/sage/interfaces/ecm.py
*** *** Error: TIMED OUT! PROCESS KILLED! *** ***
*** *** Error: TIMED OUT! *** ***
*** *** Error: TIMED OUT! *** ***
[1800.1 s]
}}}
This error has nothing to do with the patch. It might be due to sage.math
being too busy or its system resources (probably RAM) nearing capacity.
Merged `trac_6568-jinja_migration_v2.patch`.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/6568#comment:33>
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
-~----------~----~----~----~------~----~------~--~---