Trac #18163: Ref: add various missing modules to r/modules

URL: http://trac.sagemath.org/18163 Reported by: mmezzarobba Ticket author(s): Marc Mezzarobba Reviewer(s): Jeroen Demeyer
sagemath · May 31, 2015 · 8531803 · 8531803
2 parents 82d2d88 + 42f3e8b
commit 8531803
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 17 deletions.
diff --git a/src/doc/en/reference/modules/index.rst b/src/doc/en/reference/modules/index.rst
@@ -32,4 +32,18 @@ Modules
    sage/modules/with_basis/morphism
    sage/modules/with_basis/subquotient
 
+   sage/modules/finite_submodule_iter
+   sage/modules/free_quadratic_module
+   sage/modules/misc
+   sage/modules/quotient_module
+
+   sage/modules/vector_complex_double_dense
+   sage/modules/vector_double_dense
+   sage/modules/vector_integer_dense
+   sage/modules/vector_mod2_dense
+   sage/modules/vector_modn_dense
+   sage/modules/vector_rational_dense
+   sage/modules/vector_real_double_dense
+   sage/modules/vector_symbolic_dense
+
 .. include:: ../footer.txt
diff --git a/src/sage/modules/free_quadratic_module.py b/src/sage/modules/free_quadratic_module.py
@@ -8,13 +8,13 @@
 can specify and change.
 
 Create the free module of rank `n` over an arbitrary commutative ring `R`
-using the command \code{FreeModule(R,n)} with a given inner_product_matrix.
+using the command ``FreeModule(R,n)`` with a given inner_product_matrix.
 
 The following example illustrates the creation of both a vector spaces
 and a free module over the integers and a submodule of it.  Use the functions
-\code{FreeModule}, \code{span} and member functions of free modules
-to create free modules.  \emph{Do not use the FreeModule\_xxx constructors
-directly.}
+``FreeModule``, ``span`` and member functions of free modules
+to create free modules.  ''Do not use the ``FreeModule_xxx`` constructors
+directly.''
 
 EXAMPLES::
 
@@ -116,9 +116,9 @@ def FreeQuadraticModule(
 
     .. NOTE::
 
-    In Sage, there is only one dense and one sparse free ambient
-    quadratic module of rank `n` over `R` and given inner product
-    matrix.
+        In Sage it is the case that there is only one dense and one
+        sparse free ambient quadratic module of rank `n` over `R` and given
+        inner product matrix.
 
     EXAMPLES::
 
@@ -1460,9 +1460,9 @@ class FreeQuadraticModule_submodule_with_basis_field(
         [ 1  2  3]
         [ 4  5 19]
 
-        Since this is an embedded vector subspace with a distinguished user
-        basis possibly different than the echelonized basis, the
-        echelon_coordinates() and user coordinates() do not agree:
+    Since this is an embedded vector subspace with a distinguished user
+    basis possibly different than the echelonized basis, the
+    ``echelon_coordinates()`` and user ``coordinates()`` do not agree::
 
         sage: V = QQ^3
         sage: W = V.submodule_with_basis([[1,2,3], [4,5,6]])

diff --git a/src/sage/modules/misc.py b/src/sage/modules/misc.py
@@ -2,7 +2,8 @@
 Miscellaneous module-related functions.
 
 AUTHORS:
-    -- William Stein (2007-11-18)
+
+- William Stein (2007-11-18)
 """
 
 ####################################################################################
@@ -35,7 +36,7 @@ def gram_schmidt(B):
         could be.  Instead, see :meth:`sage.matrix.matrix2.Matrix2.gram_schmidt`
         which is safer and more general-purpose.
 
-    EXAMPLES:
+    EXAMPLES::
 
         sage: B = [vector([1,2,1/5]), vector([1,2,3]), vector([-1,0,0])]
         sage: from sage.modules.misc import gram_schmidt

diff --git a/src/sage/modules/vector_double_dense.pyx b/src/sage/modules/vector_double_dense.pyx
@@ -1,6 +1,8 @@
 r"""
-Dense vectors using a NumPy backend.  This serves as a base class for
-dense vectors over Real Double Field and Complex Double Field
+Dense vectors using a NumPy backend.
+
+This serves as a base class for dense vectors over Real Double Field and
+Complex Double Field
 
 EXAMPLES::
 
@@ -24,7 +26,7 @@ EXAMPLES::
 AUTHORS:
 
 - Jason Grout, Oct 2008: switch to numpy backend, factored out
-       Vector_double_dense class
+  ``Vector_double_dense`` class
 - Josh Kantor
 - William Stein
 """

diff --git a/src/sage/modules/vector_mod2_dense.pyx b/src/sage/modules/vector_mod2_dense.pyx
@@ -4,7 +4,6 @@ Vectors with elements in GF(2).
 AUTHOR:
 
 - Martin Albrecht (2009-12): initial implementation
-
 - Thomas Feulner (2012-11): added :meth:`Vector_mod2_dense.hamming_weight`
 
 EXAMPLES::
@@ -461,7 +460,7 @@ cdef class Vector_mod2_dense(free_module_element.FreeModuleElement):
 
         INPUT:
 
-        - ``copy`` - always ``True
+        - ``copy`` - always ``True``
 
         EXAMPLE::