#6724: [with patch, needs work] spell-check all modules under sage/modules
---------------------------+------------------------------------------------
Reporter: mvngu | Owner: tba
Type: defect | Status: new
Priority: major | Milestone: sage-4.1.1
Component: documentation | Keywords:
Reviewer: | Author: Minh Van Nguyen
Merged: |
---------------------------+------------------------------------------------
Comment(by mvngu):
Here I start again, outlining specific steps so that we are in sync on
what's going on.
* I took the sage.math binary of Sage 4.1.1.rc2, uncompressed it and ran
it:
{{{
[mv...@sage mvngu]$ pwd
/scratch/mvngu
[mv...@sage mvngu]$ tar -zxf
/home/mvngu/release/sage-4.1.1.rc2-sage.math.washington.edu-x86_64-Linux.tar.gz
-C .
[mv...@sage mvngu]$ cd
sage-4.1.1.rc2-sage.math.washington.edu-x86_64-Linux/
[mv...@sage sage-4.1.1.rc2-sage.math.washington.edu-x86_64-Linux]$ ./sage
----------------------------------------------------------------------
| Sage Version 4.1.1.rc2, Release Date: 2009-08-06 |
| Type notebook() for the GUI, and license() for information. |
----------------------------------------------------------------------
**********************************************************************
* *
* Warning: this is a prerelease version, and it may be unstable. *
* *
**********************************************************************
The Sage install tree may have moved.
Regenerating Python.pyo and .pyc files that hardcode the install PATH
(please wait at most a few minutes)...
Do not interrupt this.
sage: exit
Exiting SAGE (CPU time 0m0.08s, Wall time 0m2.80s).
Exiting spawned Gap process.
[mv...@sage sage-4.1.1.rc2-sage.math.washington.edu-x86_64-Linux]$ ./sage
-b main
<more output messages>
}}}
* With this clean slate, the content of the file `modules.rst` should be
as follows:
{{{
[mv...@sage sage-4.1.1.rc2-sage.math.washington.edu-x86_64-Linux]$ cd
devel/sage-main/
[mv...@sage sage-main]$ cat doc/en/reference/modules.rst
.. _ch:modules:
Modules
=======
.. toctree::
:maxdepth: 2
sage/modules/module
sage/modules/free_module
sage/modules/free_module_element
sage/modules/complex_double_vector
sage/modules/real_double_vector
sage/modules/free_module_homspace
sage/modules/free_module_morphism
sage/modules/matrix_morphism
sage/modules/fg_pid/fgp_module
sage/modules/fg_pid/fgp_element
sage/modules/fg_pid/fgp_morphism
}}}
* Now I merge the patches at #6723, #6731, and #6724 (in that order)
using Mercurial queue:
{{{
[mv...@sage sage-main]$ hg qimport http://trac.sagemath.org/sage_trac/raw-
attachment/ticket/6723/trac_6723-spell-check-modular.patch && hg qpush
adding trac_6723-spell-check-modular.patch to series file
applying trac_6723-spell-check-modular.patch
Now at: trac_6723-spell-check-modular.patch
[mv...@sage sage-main]$ hg qimport http://trac.sagemath.org/sage_trac/raw-
attachment/ticket/6731/trac_6731-spell-check-schemes.patch && hg qpush
adding trac_6731-spell-check-schemes.patch to series file
applying trac_6731-spell-check-schemes.patch
Now at: trac_6731-spell-check-schemes.patch
[mv...@sage sage-main]$ hg qimport http://trac.sagemath.org/sage_trac/raw-
attachment/ticket/6724/trac_6724-spell-check-modules.patch && hg qpush
adding trac_6724-spell-check-modules.patch to series file
applying trac_6724-spell-check-modules.patch
Now at: trac_6724-spell-check-modules.patch
}}}
* The content of the file `modules.rst` should not and have not been
changed because the patches at #6723, #6731, and #6724 don't touch that
file at all. This file controls what goes into the section on modules of
the the built reference manual.
{{{
[mv...@sage sage-main]$ cat doc/en/reference/modules.rst
.. _ch:modules:
Modules
=======
.. toctree::
:maxdepth: 2
sage/modules/module
sage/modules/free_module
sage/modules/free_module_element
sage/modules/complex_double_vector
sage/modules/real_double_vector
sage/modules/free_module_homspace
sage/modules/free_module_morphism
sage/modules/matrix_morphism
sage/modules/fg_pid/fgp_module
sage/modules/fg_pid/fgp_element
sage/modules/fg_pid/fgp_morphism
}}}
* I now rebuild those library files that have changed and then proceed to
build the reference manual:
{{{
[mv...@sage sage-main]$ cd ../..
[mv...@sage sage-4.1.1.rc2-sage.math.washington.edu-x86_64-Linux]$ ./sage
-b main
<compiler messages>
[mv...@sage sage-4.1.1.rc2-sage.math.washington.edu-x86_64-Linux]$ ./sage
-docbuild reference html
<output messages>
}}}
* The only warnings I see are those relating to bad ReST formatting in
`sage/graphs/graph.py`:
{{{
WARNING:
/scratch/mvngu/sage-4.1.1.rc2-sage.math.washington.edu-x86_64-Linux/local/lib/python2.6
/site-packages/sage/graphs/graph.py:docstring of
sage.graphs.graph.GenericGraph.kirchhoff_matrix:56: (WARNING/2) Literal
block ends without a blank line; unexpected unindent.
WARNING:
/scratch/mvngu/sage-4.1.1.rc2-sage.math.washington.edu-x86_64-Linux/local/lib/python2.6
/site-packages/sage/graphs/graph.py:docstring of
sage.graphs.graph.GenericGraph.laplacian_matrix:56: (WARNING/2) Literal
block ends without a blank line; unexpected unindent.
WARNING:
/scratch/mvngu/sage-4.1.1.rc2-sage.math.washington.edu-x86_64-Linux/local/lib/python2.6
/site-packages/sage/graphs/graph.py:docstring of
sage.graphs.graph.Graph.clique_number:19: (WARNING/2) Inline literal
start-string without end-string.
}}}
But this can be resolved with the patch at #6684.
* If after following the steps above and you still get the same warnings
you reported above, you might instead want to apply the patch `trac_6724
-spell-check-modules-reduced.patch`. It's a reduced version of the patch
`trac_6724-spell-check-modules.patch` with the following hunk removed:
{{{
diff -r 87b600f2b8d5 -r e457c012dba6 sage/modules/fg_pid/fgp_morphism.py
--- a/sage/modules/fg_pid/fgp_morphism.py
+++ b/sage/modules/fg_pid/fgp_morphism.py
@@ -441,7 +441,7 @@
raise ValueError, "no lift of element to domain"
# Write back in terms of rows of B, and delete rows not
corresponding to A,
- # since those coresponding to relations
+ # since those corresponding to relations
v = (z*U)[:A.nrows()]
# Take the linear combination that v defines.
}}}
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/6724#comment:5>
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
-~----------~----~----~----~------~----~------~--~---
