Trac #28619: Reference manual doesn't build with --include-tests-blocks

Blocks starting with `TESTS` are omitted, by default, in the reference
manual, but can be included by passing `--include-tests-blocks` to `sage
--docbuild`. The goal here is fix errors in the docstrings so that
building with this option actually works.

URL: https://trac.sagemath.org/28619
Reported by: jhpalmieri
Ticket author(s): John Palmieri
Reviewer(s): Frédéric Chapoton

Author: Release Manager

src/sage/algebras/group_algebra.py

@@ -5,21 +5,21 @@
 
 TESTS:
 
-Check that unpicking old group algebra classes work::
-
-sage: G = loads(b"x\x9cM\xceM\n\xc20\x10\x86a\xac\xff\xf1$n\xb2\xf1\x04\x82"
-....:           b"\xe8>\xe0:\xc4fL\x83i\xda\x99$K\xc1M\xf5\xdaj\x1a\xc1\xdd<"
-....:           b"\xf0\xbd0\x8f\xaa\x0e\xca\x00\x0f\x91R\x1d\x13\x01O\xdeb\x02I"
-....:           b"\xd0\x13\x04\xf0QE\xdby\x96<\x81N50\x9c\x8c\x81r\x06.\xa4\x027"
-....:           b"\xd4\xa5^\x16\xb2\xd3W\xfb\x02\xac\x9a\xb2\xce\xa3\xc0{\xa0V"
-....:           b"\x9ar\x8c\xa1W-hv\xb0\rhR.\xe7\x0c\xa7cE\xd6\x9b\xc0\xad\x8f`"
-....:           b"\x80X\xabn \x7f\xc0\xd9y\xb2\x1b\x04\xce\x87\xfb\x0b\x17\x02"
-....:           b"\x97\xff\x05\xe5\x9f\x95\x93W\x0bN3Qx\xcc\xc2\xd5V\xe0\xfa\xf9"
-....:           b"\xc9\x98\xc0\r\x7f\x03\x9d\xd7^'")
-sage: G
-Algebra of Dihedral group of order 6 as a permutation group over Rational Field
-sage: type(G)
-<class 'sage.algebras.group_algebra.GroupAlgebra_class_with_category'>
+Check that unpicking old group algebra classes works::
+
+    sage: G = loads(b"x\x9cM\xceM\n\xc20\x10\x86a\xac\xff\xf1$n\xb2\xf1\x04\x82"
+    ....:           b"\xe8>\xe0:\xc4fL\x83i\xda\x99$K\xc1M\xf5\xdaj\x1a\xc1\xdd<"
+    ....:           b"\xf0\xbd0\x8f\xaa\x0e\xca\x00\x0f\x91R\x1d\x13\x01O\xdeb\x02I"
+    ....:           b"\xd0\x13\x04\xf0QE\xdby\x96<\x81N50\x9c\x8c\x81r\x06.\xa4\x027"
+    ....:           b"\xd4\xa5^\x16\xb2\xd3W\xfb\x02\xac\x9a\xb2\xce\xa3\xc0{\xa0V"
+    ....:           b"\x9ar\x8c\xa1W-hv\xb0\rhR.\xe7\x0c\xa7cE\xd6\x9b\xc0\xad\x8f`"
+    ....:           b"\x80X\xabn \x7f\xc0\xd9y\xb2\x1b\x04\xce\x87\xfb\x0b\x17\x02"
+    ....:           b"\x97\xff\x05\xe5\x9f\x95\x93W\x0bN3Qx\xcc\xc2\xd5V\xe0\xfa\xf9"
+    ....:           b"\xc9\x98\xc0\r\x7f\x03\x9d\xd7^'")
+    sage: G
+    Algebra of Dihedral group of order 6 as a permutation group over Rational Field
+    sage: type(G)
+    <class 'sage.algebras.group_algebra.GroupAlgebra_class_with_category'>
 """
 
 #*****************************************************************************

src/sage/coding/linear_code.py

@@ -349,7 +349,7 @@ class AbstractLinearCode(AbstractCode, Module):
         It is thus strongly recommended to set an encoder with a generator matrix implemented
         as a default encoder.
 
-        TESTS::
+        TESTS:
 
         This class uses the following experimental feature:
         :class:`sage.coding.relative_finite_field_extension.RelativeFiniteFieldExtension`.

src/sage/combinat/designs/difference_family.py

@@ -1518,8 +1518,8 @@ def difference_family(v, k, l=1, existence=False, explain_construction=False, ch
         ...
         NotImplementedError: No construction available for (9,3,1)-difference family
 
-    Check that when ``existence=True`` we always obtain ``True``, ``False`` or ``Unknown``
-    and when ``explain_construction=True``it is a string (see :trac:`24513`)::
+    Check that when ``existence=True`` we always obtain ``True``, ``False`` or ``Unknown``,
+    and when ``explain_construction=True``, it is a string (see :trac:`24513`)::
 
         sage: designs.difference_family(3, 2, 1, existence=True)
         True

src/sage/geometry/polyhedron/backend_cdd.py

@@ -412,7 +412,7 @@ class Polyhedron_RDF_cdd(Polyhedron_cdd, Polyhedron_RDF):
 
     TESTS:
 
-    Checks that :ticket:`24877` is fixed::
+    Checks that :trac:`24877` is fixed::
 
         sage: n1 = 1045602428815736513789288687833080060779
         sage: n2 = 76591188009721216624438400001815308369088648782156930777145

src/sage/geometry/polyhedron/base.py

@@ -4661,11 +4661,11 @@ def wedge(self, face, width=1):
 
         For more information, see Chapter 15 of [HoDaCG17]_.
 
-        TESTS::
+        TESTS:
 
         The backend should be preserved as long as the value of width permits.
         The base_ring will change to the field of fractions of the current
-        base_ring, unless width forces a different ring.
+        base_ring, unless width forces a different ring. ::
 
             sage: P = polytopes.cyclic_polytope(3,7, base_ring=ZZ, backend='field')
             sage: W1 = P.wedge(P.faces(2)[0]); W1.base_ring(); W1.backend()
@@ -5938,7 +5938,7 @@ def _volume_latte(self, verbose=False, algorithm='triangulate', **kwargs):
             sage: polytopes.cuboctahedron()._volume_latte() #optional - latte_int
             20/3
 
-        TESTS::
+        TESTS:
 
         Testing triangulate algorithm::
 
@@ -6303,7 +6303,7 @@ def integrate(self, polynomial, **kwds):
             ...
             NotImplementedError: the polytope must be full-dimensional
 
-        TESTS::
+        TESTS:
 
         Testing a three-dimensional integral::
 

src/sage/graphs/generators/families.py

@@ -632,7 +632,7 @@ def BarbellGraph(n1, n2):
         sage: P_n2.is_isomorphic(s_P)
         True
 
-    TESTS:
+    TESTS::
 
         sage: n1, n2 = randint(3, 10), randint(0, 10)
         sage: g = graphs.BarbellGraph(n1, n2)
@@ -709,7 +709,7 @@ def LollipopGraph(n1, n2):
         Lollipop graph: Graph on 17 vertices
         sage: g.show() # long time
 
-    TESTS:
+    TESTS::
 
         sage: n1, n2 = randint(3, 10), randint(0, 10)
         sage: g = graphs.LollipopGraph(n1, n2)
@@ -782,7 +782,7 @@ def TadpoleGraph(n1, n2):
         Tadpole graph: Graph on 17 vertices
         sage: g.show() # long time
 
-    TESTS:
+    TESTS::
 
         sage: n1, n2 = randint(3, 10), randint(0, 10)
         sage: g = graphs.TadpoleGraph(n1, n2)
@@ -875,7 +875,7 @@ def DipoleGraph(n):
         Dipole graph: Multi-graph on 2 vertices
         sage: g.show() # long time
 
-    TESTS:
+    TESTS::
 
         sage: n = randint(0, 10)
         sage: g = graphs.DipoleGraph(n)

src/sage/interfaces/latte.py

@@ -247,7 +247,7 @@ def integrate(arg, polynomial=None, algorithm='triangulate', raw_output=False, v
         sage: integrate(P.cdd_Hrepresentation(), '[[1,[2,2,2]]]', cdd=True)   # optional - latte_int
         4096/27
 
-    TESTS::
+    TESTS:
 
     Testing raw output::
 
@@ -399,7 +399,7 @@ def to_latte_polynomial(polynomial):
 
     A string that describes the monomials list and exponent vectors.
 
-    TESTS::
+    TESTS:
 
     Testing a polynomial in three variables::
 

src/sage/matrix/matrix_integer_dense.pyx

@@ -1224,7 +1224,7 @@ cdef class Matrix_integer_dense(Matrix_dense):
         return self, ZZ(1)
 
     def charpoly(self, var='x', algorithm=None):
-        """
+        r"""
         .. NOTE::
 
             The characteristic polynomial is defined as `\det(xI-A)`.
@@ -1346,7 +1346,7 @@ cdef class Matrix_integer_dense(Matrix_dense):
         return g
 
     def minpoly(self, var='x', algorithm=None):
-        """
+        r"""
         INPUT:
 
 

src/sage/misc/cachefunc.pyx

@@ -1318,7 +1318,7 @@ cdef class WeakCachedFunction(CachedFunction):
         sage: mod_ring(1,algorithm="default") is mod_ring(1,algorithm="algorithm") is mod_ring(1) is mod_ring(1,'default')
         True
 
-    TESTS::
+    TESTS:
 
     Check that :trac:`16316` has been fixed, i.e., caching works for
     immutable unhashable objects which define

src/sage/modules/free_quadratic_module.py

@@ -123,7 +123,7 @@ def FreeQuadraticModule(
         sage: M3 is M2
         True
 
-    TESTS::
+    TESTS:
 
     Check for :trac:`10577`::