Docstring edits

"<string>" to '<string>', remove indefinite articles and trailing dots, one-line outputs, etc.

src/sage/algebras/commutative_dga.py

@@ -935,7 +935,7 @@ def __classcall__(cls, base, names=None, degrees=None, R=None, I=None, category=
         - ``base`` -- the base ring of the algebra
 
         - ``names`` -- the names of the variables; by default, set to ``x1``,
-          ``x2``, etc.
+          ``x2``, etc
 
         - ``degrees`` -- the degrees of the generators; by default, set to 1
 

src/sage/algebras/finite_gca.py

@@ -146,7 +146,7 @@ def __classcall_private__(cls, base, names=None, degrees=None,
         - ``base`` -- the base ring of the algebra
         - ``max_degree`` -- the maximal degree of the algebra
         - ``names`` -- the names of the variables; by default, set to ``x1``,
-          ``x2``, etc.
+          ``x2``, etc
         - ``degrees`` -- the degrees of the generators; by default, set to 1
 
         TESTS::

src/sage/algebras/fusion_rings/shm_managers.pyx

@@ -399,7 +399,7 @@ cdef class FvarsHandler:
     - ``init_data`` -- a dictionary or :class:`FvarsHandler` object containing
       known squares for initialization, e.g., from a solver checkpoint
     - ``use_mp`` -- integer indicating the number of child processes
-      used for multiprocessing; if running serially, use 0.
+      used for multiprocessing; if running serially, use 0
     - ``pids_name`` -- the name of a ``ShareableList`` contaning the
       process ``pid``'s for every process in the pool (including the
       parent process)

src/sage/algebras/lie_conformal_algebras/affine_lie_conformal_algebra.py

@@ -43,7 +43,7 @@ class AffineLieConformalAlgebra(GradedLieConformalAlgebra):
     INPUT:
 
     - ``R`` -- a commutative Ring; the base ring for this Lie
-      conformal algebra.
+      conformal algebra
     - ``ct`` -- a ``str`` or a :mod:`CartanType<sage.combinat.\
       root_system.cartan_type>`; the Cartan Type for
       the corresponding finite dimensional Lie algebra. It must
@@ -55,7 +55,7 @@ class AffineLieConformalAlgebra(GradedLieConformalAlgebra):
     - ``prefix`` -- a ``str``; parameter passed to
       :class:`IndexedGenerators<sage.structure.indexed_generators.IndexedGenerators>`
     - ``bracket`` -- a ``str``; parameter passed to
-      :class:`IndexedGenerators<sage.structure.indexed_generators.IndexedGenerators>`.
+      :class:`IndexedGenerators<sage.structure.indexed_generators.IndexedGenerators>`
 
     EXAMPLES::
 

src/sage/algebras/lie_conformal_algebras/bosonic_ghosts_lie_conformal_algebra.py

@@ -48,7 +48,7 @@ class BosonicGhostsLieConformalAlgebra(GradedLieConformalAlgebra):
     - ``names`` -- list of ``str``; alternative names for the
       generators
     - ``index_set`` -- an enumerated set; An indexing set for the
-      generators.
+      generators
 
     OUTPUT:
 

src/sage/algebras/lie_conformal_algebras/fermionic_ghosts_lie_conformal_algebra.py

@@ -45,7 +45,7 @@ class FermionicGhostsLieConformalAlgebra(GradedLieConformalAlgebra):
     - ``names`` -- a tuple of ``str``; alternative names for the
       generators
     - ``index_set`` -- an enumerated set; alternative indexing
-      set for the generators.
+      set for the generators
 
     OUTPUT:
 

src/sage/algebras/lie_conformal_algebras/free_bosons_lie_conformal_algebra.py

@@ -52,7 +52,7 @@ class FreeBosonsLieConformalAlgebra(GradedLieConformalAlgebra):
     - ``names`` -- a tuple of ``str``; alternative names for the
       generators
     - ``index_set`` -- an enumerated set; alternative indexing set
-      for the generators.
+      for the generators
 
     OUTPUT:
 

src/sage/algebras/lie_conformal_algebras/lie_conformal_algebra_with_structure_coefs.py

@@ -122,7 +122,7 @@ def _standardize_s_coeff(s_coeff, index_set, ce, parity=None):
         INPUT:
 
         - ``s_coeff`` -- a dictionary as in
-          :class:`~sage.algebras.lie_conformal_algebras.lie_conformal_algebra_with_structure_coefficients.LieConformalAlgebraWithStructureCoefficients`.
+          :class:`~sage.algebras.lie_conformal_algebras.lie_conformal_algebra_with_structure_coefficients.LieConformalAlgebraWithStructureCoefficients`
         - ``index_set`` -- a finite enumerated set indexing the
           generators (not counting the central elements).
         - ``ce`` -- a tuple of ``str``; a list of names for the central

src/sage/algebras/lie_conformal_algebras/n2_lie_conformal_algebra.py

@@ -40,7 +40,7 @@ class N2LieConformalAlgebra(GradedLieConformalAlgebra):
     INPUT:
 
     - ``R`` -- a commutative ring; the base ring of this super
-      Lie conformal algebra.
+      Lie conformal algebra
 
     EXAMPLES::
 

src/sage/algebras/lie_conformal_algebras/neveu_schwarz_lie_conformal_algebra.py

@@ -35,7 +35,7 @@ class NeveuSchwarzLieConformalAlgebra(GradedLieConformalAlgebra):
     INPUT:
 
     - ``R`` -- a commutative Ring; the base ring of this Lie
-      conformal algebra.
+      conformal algebra
 
     EXAMPLES::
 

src/sage/algebras/lie_conformal_algebras/virasoro_lie_conformal_algebra.py

@@ -36,7 +36,7 @@ class VirasoroLieConformalAlgebra(GradedLieConformalAlgebra):
     INPUT:
 
     - ``R`` -- a commutative ring; behaviour is undefined if `R` is
-      not a Field of characteristic zero.
+      not a Field of characteristic zero
 
     EXAMPLES::
 

src/sage/algebras/lie_conformal_algebras/weyl_lie_conformal_algebra.py

@@ -47,11 +47,11 @@ class WeylLieConformalAlgebra(LieConformalAlgebraWithStructureCoefficients):
     INPUT:
 
     - ``R`` -- a commutative ring; the base ring of this Lie
-      conformal algebra.
-    - ``ngens``: an even positive Integer (default: `2`); The number
-      of non-central generators of this Lie conformal algebra.
-    - ``gram_matrix``: a matrix (default: ``None``); A non-singular
-      skew-symmetric square matrix with coefficients in `R`.
+      conformal algebra
+    - ``ngens``: an even positive Integer (default: `2`); the number
+      of non-central generators of this Lie conformal algebra
+    - ``gram_matrix``: a matrix (default: ``None``); a non-singular
+      skew-symmetric square matrix with coefficients in `R`
     - ``names`` -- list or tuple of ``str``; alternative names
       for the generators
     - ``index_set`` -- an enumerated set; alternative indexing set

src/sage/algebras/quatalg/quaternion_algebra.py

@@ -3704,10 +3704,10 @@ def is_principal(self, certificate=False):
 
         INPUT:
 
-        - ``certificate`` -- if ``True`` returns a generator alpha s.t. I = alpha*O
-          where O is the right order of I.
+        - ``certificate`` -- if ``True`` returns a generator alpha s.t.
+          `I = \alpha O` where `O` is the right order of `I`
 
-        OUTPUT: bool, or (bool, alpha) if ``certificate`` is ``True``
+        OUTPUT: boolean, or (boolean, alpha) if ``certificate`` is ``True``
 
         EXAMPLES::
 

src/sage/algebras/steenrod/steenrod_algebra.py

@@ -4004,7 +4004,7 @@ def SteenrodAlgebra(p=2, basis='milnor', generic='auto', **kwds):
     - a function from positive integers to nonnegative integers (and
       `\infty`), e.g., ``lambda n: n+2``.
     - ``None`` or ``Infinity`` -- use this for the profile function for
-      the whole Steenrod algebra.
+      the whole Steenrod algebra
 
     In the first and third cases, ``precision`` is ignored.  In the
     second case, this function is converted to a tuple of length one
@@ -4082,7 +4082,7 @@ def SteenrodAlgebra(p=2, basis='milnor', generic='auto', **kwds):
       1 if n<3 else 2)``.
 
     - ``None`` or ``Infinity`` -- use this for the profile function for
-      the whole Steenrod algebra.
+      the whole Steenrod algebra
 
     You can also mix and match the first two, passing a pair with
     first entry a list and second entry a function, for instance.  The

src/sage/arith/functions.pyx

@@ -30,7 +30,7 @@ def lcm(a, b=None):
 
     - ``a``, ``b`` -- two elements of a ring with lcm or
 
-    - ``a`` -- list, tuple or iterable of elements of a ring with lcm
+    - ``a`` -- list; tuple or iterable of elements of a ring with lcm
 
     OUTPUT:
 

src/sage/arith/misc.py

@@ -2323,10 +2323,10 @@ def rational_reconstruction(a, m, algorithm='fast'):
 
     - ``m`` -- a modulus
 
-    - ``algorithm`` -- (default: 'fast')
+    - ``algorithm`` -- string (default: ``'fast'``s)
 
       - ``'fast'`` -- a fast implementation using direct GMP library calls
-        in Cython.
+        in Cython
 
     OUTPUT:
 

src/sage/calculus/desolvers.py

@@ -1510,8 +1510,9 @@ def desolve_odeint(des, ics, times, dvars, ivar=None, compute_jac=False, args=()
 
     - ``ivar`` -- independent variable, optional
 
-    - ``compute_jac`` -- boolean. If True, the Jacobian of ``des`` is computed and
-      used during the integration of stiff systems. Default value is False.
+    - ``compute_jac`` -- boolean (default: ``False``); if ``True``, the
+      Jacobian of ``des`` is computed and used during the integration of stiff
+      systems
 
     Other Parameters (taken from the documentation of the
     :func:`~scipy:scipy.integrate.odeint` function from
@@ -1694,8 +1695,8 @@ def desolve_mintides(f, ics, initial, final, delta, tolrel=1e-16, tolabs=1e-16):
 
     INPUT:
 
-    - ``f`` -- symbolic function. Its first argument will be the independent
-      variable. Its output should be de derivatives of the dependent variables.
+    - ``f`` -- symbolic function; its first argument will be the independent
+      variable, . Its output should be de derivatives of the dependent variables.
 
     - ``ics`` -- list or tuple with the initial conditions
 
@@ -1783,7 +1784,7 @@ def desolve_tides_mpfr(f, ics, initial, final, delta, tolrel=1e-16, tolabs=1e-16
 
     INPUT:
 
-    - ``f`` -- symbolic function. Its first argument will be the independent
+    - ``f`` -- symbolic function; its first argument will be the independent
       variable. Its output should be de derivatives of the dependent variables.
 
     - ``ics`` -- list or tuple with the initial conditions

src/sage/calculus/interpolators.pyx

@@ -105,8 +105,8 @@ cdef class PSpline:
 
         INPUT:
 
-        - ``t`` -- double, the parameter value for the parameterized curve,
-          between 0 and 2*pi.
+        - ``t`` -- double; the parameter value for the parameterized curve,
+          between 0 and 2*pi
 
         OUTPUT:
 
@@ -138,8 +138,8 @@ cdef class PSpline:
 
         INPUT:
 
-        - ``t`` -- double, the parameter value for the parameterized curve,
-          between 0 and 2*pi.
+        - ``t`` -- double; the parameter value for the parameterized curve,
+          between 0 and 2*pi
 
         OUTPUT:
 
@@ -262,8 +262,8 @@ cdef class CCSpline:
 
         INPUT:
 
-        - ``t`` -- double, the parameter value for the parameterized curve,
-          between 0 and 2*pi.
+        - ``t`` -- double; the parameter value for the parameterized curve,
+          between 0 and 2*pi
 
         OUTPUT:
 
@@ -296,8 +296,8 @@ cdef class CCSpline:
 
         INPUT:
 
-        - ``t`` -- double, the parameter value for the parameterized curve,
-          between 0 and 2*pi.
+        - ``t`` -- double; the parameter value for the parameterized curve,
+          between 0 and 2*pi
 
         OUTPUT:
 

src/sage/calculus/riemann.pyx

@@ -863,7 +863,7 @@ cdef class Riemann_Map:
           behavior of the radial lines near the boundaries.
           - only for simply connected domains
 
-        - ``linescale`` -- float between 0 and 1. Shrinks the radial lines
+        - ``linescale`` -- float between 0 and 1; shrinks the radial lines
           away from the boundary to reduce erratic behavior.
           - only for simply connected domains
 
@@ -1435,7 +1435,7 @@ cpdef cauchy_kernel(t, args):
       - ``z`` -- complex; the point to be mapped
 
       - ``n`` -- integer; the number of terms to include
-        10 is fairly accurate, 20 is very accurate.
+        (10 is fairly accurate, 20 is very accurate)
 
       - ``part`` -- will return the real ('r'), imaginary ('i') or
         complex ('c') value of the kernel

src/sage/calculus/transforms/fft.pyx

@@ -299,9 +299,9 @@ cdef class FastFourierTransform_complex(FastFourierTransform_base):
         - ``style`` -- style of the plot, options are ``'rect'`` or ``'polar'``
 
           - ``'rect'`` -- height represents real part, color represents
-            imaginary part.
+            imaginary part
           - ``'polar'`` -- height represents absolute value, color
-            represents argument.
+            represents argument
 
         - ``xmin`` -- the lower bound of the slice to plot; 0 by default
         - ``xmax`` -- the upper bound of the slice to plot; ``len(self)`` by default

src/sage/categories/category.py

@@ -2716,7 +2716,7 @@ def _make_named_class(self, name, method_provider, cache=False, **options):
           ``self`` that provides methods for the new class (in
           addition to what comes from the super categories)
         - ``**options`` -- other named options to pass down to
-          :meth:`Category._make_named_class`.
+          :meth:`Category._make_named_class`
 
         ASSUMPTION:
 

src/sage/categories/category_cy_helper.pyx

@@ -122,12 +122,12 @@ cpdef tuple join_as_tuple(tuple categories, tuple axioms, tuple ignore_axioms):
 
     INPUT:
 
-    - ``categories`` -- tuple of categories to be joined,
+    - ``categories`` -- tuple of categories to be joined
     - ``axioms`` -- tuple of strings; the names of some
-      supplementary axioms.
+      supplementary axioms
     - ``ignore_axioms`` -- tuple of pairs ``(cat, axiom)``, such
       that ``axiom`` will not be applied to ``cat``, should ``cat``
-      occur in the algorithm.
+      occur in the algorithm
 
     EXAMPLES::
 

src/sage/categories/crystals.py

@@ -124,12 +124,12 @@ def example(self, choice='highwt', **kwds):
 
         INPUT:
 
-        - ``choice`` -- string (default: ``'highwt'``); an be either ``'highwt'``
+        - ``choice`` -- string (default: ``'highwt'``); can be either ``'highwt'``
           for the highest weight crystal of type A, or ``'naive'`` for an
-          example of a broken crystal.
+          example of a broken crystal
 
         - ``**kwds`` -- keyword arguments passed onto the constructor for the
-          chosen crystal.
+          chosen crystal
 
         EXAMPLES::
 

src/sage/categories/examples/finite_coxeter_groups.py

@@ -185,7 +185,7 @@ class Element(ElementWrapper):
         wrapped_class = tuple
         __lt__ = ElementWrapper._lt_by_value
 
-        def has_right_descent(self, i, positive=False, side="right"):
+        def has_right_descent(self, i, positive=False, side='right'):
             r"""
             Implements :meth:`SemiGroups.ElementMethods.has_right_descent`.
 

src/sage/categories/examples/finite_semigroups.py

@@ -71,7 +71,7 @@ class LeftRegularBand(UniqueRepresentation, Parent):
     Now, let us look at the structure of the semigroup::
 
         sage: S = FiniteSemigroups().example(alphabet = ('a','b','c'))
-        sage: S.cayley_graph(side="left", simple=True).plot()                           # needs sage.graphs sage.plot
+        sage: S.cayley_graph(side='left', simple=True).plot()                           # needs sage.graphs sage.plot
         Graphics object consisting of 60 graphics primitives
         sage: S.j_transversal_of_idempotents()  # random (arbitrary choice)             # needs sage.graphs
         ['acb', 'ac', 'ab', 'bc', 'a', 'c', 'b']

src/sage/categories/examples/finite_weyl_groups.py

@@ -61,7 +61,7 @@ class SymmetricGroup(UniqueRepresentation, Parent):
         24
         sage: S.long_element()
         (3, 2, 1, 0)
-        sage: S.cayley_graph(side="left").plot()                                        # needs sage.graphs sage.plot
+        sage: S.cayley_graph(side='left').plot()                                        # needs sage.graphs sage.plot
         Graphics object consisting of 120 graphics primitives
 
     Alternatively, one could have implemented