add missing colon to EXAMPLES: if followed by a code block

sagemath · Jan 7, 2019 · 79498fc · 79498fc
1 parent 71f5ae8
commit 79498fc
Show file tree

Hide file tree

Showing 103 changed files with 1,141 additions and 806 deletions.
diff --git a/src/sage/algebras/quantum_groups/q_numbers.py b/src/sage/algebras/quantum_groups/q_numbers.py
@@ -165,7 +165,7 @@ def q_binomial(n, k, q=None):
         division is not implemented in the ring containing `q`,
         then it will not work.
 
-    EXAMPLES:
+    EXAMPLES::
 
         sage: from sage.algebras.quantum_groups.q_numbers import q_binomial
         sage: q_binomial(2, 1)

diff --git a/src/sage/categories/category_with_axiom.py b/src/sage/categories/category_with_axiom.py
@@ -2189,7 +2189,7 @@ def additional_structure(self):
 
         .. SEEALSO:: :meth:`Category.additional_structure`.
 
-        EXAMPLES:
+        EXAMPLES::
 
             sage: Sets().Finite().additional_structure()
             sage: Monoids().additional_structure()

diff --git a/src/sage/categories/covariant_functorial_construction.py b/src/sage/categories/covariant_functorial_construction.py
@@ -629,7 +629,7 @@ def additional_structure(self):
             - :meth:`Category.additional_structure`.
             - :meth:`is_construction_defined_by_base`.
 
-        EXAMPLES:
+        EXAMPLES::
 
             sage: Modules(ZZ).Graded().additional_structure()
             Category of graded modules over Integer Ring

diff --git a/src/sage/categories/division_rings.py b/src/sage/categories/division_rings.py
@@ -50,7 +50,7 @@ def extra_super_categories(self):
             The :ref:`axioms-deduction-rules` section in the
             documentation of axioms
 
-        EXAMPLES:
+        EXAMPLES::
 
             sage: DivisionRings().extra_super_categories()
             (Category of domains,)

diff --git a/src/sage/categories/filtered_modules_with_basis.py b/src/sage/categories/filtered_modules_with_basis.py
@@ -789,7 +789,7 @@ def maximal_degree(self):
 
             .. SEEALSO:: :meth:`homogeneous_degree`
 
-            EXAMPLES:
+            EXAMPLES::
 
                 sage: A = ModulesWithBasis(ZZ).Filtered().example()
                 sage: x = A(Partition((3,2,1)))

diff --git a/src/sage/categories/finite_complex_reflection_groups.py b/src/sage/categories/finite_complex_reflection_groups.py
@@ -191,7 +191,7 @@ def _test_degrees(self, **options):
 
             - ``options`` -- any keyword arguments accepted by :meth:`_tester`
 
-            EXAMPLES:
+            EXAMPLES::
 
                 sage: from sage.categories.complex_reflection_groups import ComplexReflectionGroups
                 sage: W = ComplexReflectionGroups().Finite().example(); W   # optional - gap3
@@ -246,7 +246,7 @@ def _test_codegrees(self, **options):
 
             - ``options`` -- any keyword arguments accepted by :meth:`_tester`
 
-            EXAMPLES:
+            EXAMPLES::
 
                 sage: from sage.categories.complex_reflection_groups import ComplexReflectionGroups
                 sage: W = ComplexReflectionGroups().Finite().example(); W   # optional - gap3

diff --git a/src/sage/categories/functor.pyx b/src/sage/categories/functor.pyx
@@ -524,7 +524,7 @@ class ForgetfulFunctor_generic(Functor):
         """
         Return whether ``self`` is not equal to ``other``.
 
-        EXAMPLES:
+        EXAMPLES::
 
             sage: F1 = ForgetfulFunctor(FiniteFields(),Fields())
             sage: F1 != F1

diff --git a/src/sage/categories/magmas.py b/src/sage/categories/magmas.py
@@ -347,7 +347,7 @@ class Algebras(AlgebrasCategory):
 
         def extra_super_categories(self):
             """
-            EXAMPLES:
+            EXAMPLES::
 
                 sage: Magmas().Commutative().Algebras(QQ).extra_super_categories()
                 [Category of commutative magmas]
@@ -407,7 +407,7 @@ class Algebras(AlgebrasCategory):
 
             def extra_super_categories(self):
                 """
-                EXAMPLES:
+                EXAMPLES::
 
                     sage: Magmas().Commutative().Algebras(QQ).extra_super_categories()
                     [Category of commutative magmas]
@@ -722,7 +722,7 @@ class Algebras(AlgebrasCategory):
 
             def extra_super_categories(self):
                 """
-                EXAMPLES:
+                EXAMPLES::
 
                     sage: Magmas().Commutative().Algebras(QQ).extra_super_categories()
                     [Category of commutative magmas]

diff --git a/src/sage/coding/binary_code.pyx b/src/sage/coding/binary_code.pyx
@@ -1982,7 +1982,8 @@ cdef class PartitionStack:
 #        Returns an integer whose bits represent which columns are minimal cell
 #        representatives.
 #
-#        EXAMPLES:
+#        EXAMPLES::
+#
 #            sage: import sage.coding.binary_code
 #            sage: from sage.coding.binary_code import *
 #            sage: P = PartitionStack(2, 6)
@@ -2041,7 +2042,8 @@ cdef class PartitionStack:
 #        Returns an integer whose bits represent which columns are fixed. For
 #        efficiency, mcrs is the output of min_cell_reps.
 #
-#        EXAMPLES:
+#        EXAMPLES::
+#
 #            sage: import sage.coding.binary_code
 #            sage: from sage.coding.binary_code import *
 #            sage: P = PartitionStack(2, 6)
@@ -2100,7 +2102,8 @@ cdef class PartitionStack:
 #        """
 #        Returns an integer representing the first, smallest nontrivial cell of columns.
 #
-#        EXAMPLES:
+#        EXAMPLES::
+#
 #            sage: import sage.coding.binary_code
 #            sage: from sage.coding.binary_code import *
 #            sage: P = PartitionStack(2, 6)
@@ -2309,7 +2312,8 @@ cdef class PartitionStack:
 #        Split column v out, placing it before the rest of the cell it was in.
 #        Returns the location of the split column.
 #
-#        EXAMPLES:
+#        EXAMPLES::
+#
 #            sage: import sage.coding.binary_code
 #            sage: from sage.coding.binary_code import *
 #            sage: P = PartitionStack(2, 6)

diff --git a/src/sage/coding/grs.py b/src/sage/coding/grs.py
@@ -611,7 +611,7 @@ def ReedSolomonCode(base_field, length, dimension, primitive_root=None):
       one will be computed and can be recovered as ``C.evaluation_points()[1]``
       where `C` is the code returned by this method.
 
-    EXAMPLES:
+    EXAMPLES::
 
         sage: C = codes.ReedSolomonCode(GF(7), 6, 3); C
         [6, 3, 4] Reed-Solomon Code over GF(7)

diff --git a/src/sage/combinat/chas/wqsym.py b/src/sage/combinat/chas/wqsym.py
@@ -803,7 +803,7 @@ def star_involution(self):
 
                     :meth:`algebraic_complement`, :meth:`coalgebraic_complement`
 
-                EXAMPLES:
+                EXAMPLES::
 
                     sage: WQSym = algebras.WQSym(ZZ)
                     sage: X = WQSym.X()

diff --git a/src/sage/combinat/debruijn_sequence.pyx b/src/sage/combinat/debruijn_sequence.pyx
@@ -330,7 +330,7 @@ class DeBruijnSequences(UniqueRepresentation, Parent):
 
         - ``seq`` -- A sequence of integers.
 
-        EXAMPLES:
+        EXAMPLES::
 
            sage: Sequences =  DeBruijnSequences(2, 3)
            sage: Sequences.an_element() in Sequences

diff --git a/src/sage/combinat/parallelogram_polyomino.py b/src/sage/combinat/parallelogram_polyomino.py
@@ -1338,7 +1338,7 @@ def _to_ordered_tree_via_dyck(self):
         See :meth:`_to_dyck_delest_viennot` for the exact references.
         See also :meth:`to_ordered_tree()`.
 
-        EXAMPLES:
+        EXAMPLES::
 
             sage: pp = ParallelogramPolyomino([[0, 1], [1, 0]])
             sage: pp._to_ordered_tree_via_dyck()

diff --git a/src/sage/combinat/tableau.py b/src/sage/combinat/tableau.py
@@ -1908,7 +1908,7 @@ def leq(self, secondtab):
 
         - ``secondtab`` -- a tableau of the same shape as ``self``
 
-        EXAMPLES:
+        EXAMPLES::
 
             sage: T = Tableau([[1, 2], [3]])
             sage: S = Tableau([[1, 3], [3]])

diff --git a/src/sage/combinat/words/morphism.py b/src/sage/combinat/words/morphism.py
@@ -1809,7 +1809,7 @@ def fixed_point(self, letter):
 
         - ``word`` - the fixed point of ``self`` beginning with ``letter``.
 
-        EXAMPLES:
+        EXAMPLES::
 
             sage: W = FiniteWords('abc')
 

diff --git a/src/sage/combinat/words/words.py b/src/sage/combinat/words/words.py
@@ -593,7 +593,7 @@ def __call__(self, data=None, length=None, datatype=None, caching=True, check=Tr
            when reloading. Also, most iterators do not support copying and
            should not support pickling by extension.
 
-        EXAMPLES:
+        EXAMPLES::
 
             sage: W = FiniteWords()
 

diff --git a/src/sage/ext/fast_callable.pyx b/src/sage/ext/fast_callable.pyx
@@ -1125,7 +1125,8 @@ cdef class ExpressionConstant(Expression):
     r"""
     An Expression that represents an arbitrary constant.
 
-    EXAMPLES:
+    EXAMPLES::
+
         sage: from sage.ext.fast_callable import ExpressionTreeBuilder
         sage: etb = ExpressionTreeBuilder(vars=(x,))
         sage: type(etb(3))
@@ -1192,7 +1193,8 @@ cdef class ExpressionVariable(Expression):
     r"""
     An Expression that represents a variable.
 
-    EXAMPLES:
+    EXAMPLES::
+
         sage: from sage.ext.fast_callable import ExpressionTreeBuilder
         sage: etb = ExpressionTreeBuilder(vars=(x,))
         sage: type(etb.var(x))
@@ -1258,7 +1260,8 @@ cdef class ExpressionCall(Expression):
     r"""
     An Expression that represents a function call.
 
-    EXAMPLES:
+    EXAMPLES::
+
         sage: from sage.ext.fast_callable import ExpressionTreeBuilder
         sage: etb = ExpressionTreeBuilder(vars=(x,))
         sage: type(etb.call(sin, x))
@@ -1346,7 +1349,8 @@ cdef class ExpressionIPow(Expression):
     r"""
     A power Expression with an integer exponent.
 
-    EXAMPLES:
+    EXAMPLES::
+
         sage: from sage.ext.fast_callable import ExpressionTreeBuilder
         sage: etb = ExpressionTreeBuilder(vars=(x,))
         sage: type(etb.var('x')^17)
@@ -2500,4 +2504,3 @@ cdef class Wrapper:
             if isinstance(op, tuple) and op[0] == 'py_call':
                 py_calls.append(op[1])
         return py_calls
-
diff --git a/src/sage/finance/markov_multifractal_cython.pyx b/src/sage/finance/markov_multifractal_cython.pyx
@@ -28,7 +28,8 @@ def simulations(Py_ssize_t n, Py_ssize_t k,
     OUTPUT:
         list of lists
 
-    EXAMPLES:
+    EXAMPLES::
+
         sage: set_random_seed(0)
         sage: msm = finance.MarkovSwitchingMultifractal(8,1.4,1.0,0.95,3)
         sage: import sage.finance.markov_multifractal_cython
@@ -71,10 +72,3 @@ def simulations(Py_ssize_t n, Py_ssize_t k,
         S.append(t)
 
     return S
-
-
-
-
-
-
-
diff --git a/src/sage/functions/generalized.py b/src/sage/functions/generalized.py
@@ -316,7 +316,7 @@ def __init__(self):
 
         -  ``x`` - a real number or a symbolic expression
 
-        EXAMPLES:
+        EXAMPLES::
 
             sage: unit_step(-1)
             0
@@ -405,7 +405,7 @@ def __init__(self):
         r"""
         The sgn function, ``sgn(x)``.
 
-        EXAMPLES:
+        EXAMPLES::
 
             sage: sgn(-1)
             -1

diff --git a/src/sage/functions/log.py b/src/sage/functions/log.py
@@ -1278,7 +1278,7 @@ def _evalf_(self, z, m, parent=None, algorithm=None):
 
     def _maxima_init_evaled_(self, n, z):
         """
-        EXAMPLES:
+        EXAMPLES::
 
             sage: maxima_calculus(harmonic_number(x,2))
             gen_harmonic_number(2,_SAGE_VAR_x)

diff --git a/src/sage/functions/orthogonal_polys.py b/src/sage/functions/orthogonal_polys.py
@@ -602,7 +602,7 @@ def _eval_special_values_(self, n, x):
         Values known for special values of x.
         For details see [AS1964]_ 22.4 (p. 777)
 
-        EXAMPLES:
+        EXAMPLES::
 
             sage: var('n')
             n

diff --git a/src/sage/geometry/lattice_polytope.py b/src/sage/geometry/lattice_polytope.py
@@ -3922,7 +3922,7 @@ def traverse_boundary(self):
 
         Needed for plot3d function of polytopes.
 
-        EXAMPLES:
+        EXAMPLES::
 
             sage: p = lattice_polytope.cross_polytope(2).polar()
             sage: p.traverse_boundary()