Trac #34592: fix W605 in libs and rings/semirings

in pyx files, as py files are already ok

URL: https://trac.sagemath.org/34592
Reported by: chapoton
Ticket author(s): Frédéric Chapoton
Reviewer(s): Travis Scrimshaw

Author: Release Manager

src/sage/libs/eclib/mwrank.pyx

@@ -83,7 +83,7 @@ mwrank_set_precision(150)
 
 def get_precision():
     """
-    Returns the working floating point bit precision of mwrank, which is
+    Return the working floating point bit precision of mwrank, which is
     equal to the global NTL real number precision.
 
     OUTPUT:
@@ -119,7 +119,7 @@ def set_precision(n):
        This change is global and affects *all* future calls of eclib
        functions by Sage.
 
-    .. note::
+    .. NOTE::
 
         The minimal value to which the precision may be set is 53.
         Lower values will be increased to 53.
@@ -335,7 +335,7 @@ cdef class _Curvedata:   # cython class wrapping eclib's Curvedata class
         return string_sigoff(Curvedata_repr(self.x))[:-1]
 
     def silverman_bound(self):
-        """
+        r"""
         The Silverman height bound for this elliptic curve.
 
         OUTPUT:
@@ -345,7 +345,7 @@ cdef class _Curvedata:   # cython class wrapping eclib's Curvedata class
         + B`, where `h(P)` is the naive height and `\hat{h}(P)` the
         canonical height.
 
-        .. note::
+        .. NOTE::
 
             Since eclib can compute this to arbitrary precision, we
             could return a Sage real, but this is only a bound and in
@@ -364,7 +364,7 @@ cdef class _Curvedata:   # cython class wrapping eclib's Curvedata class
         return Curvedata_silverman_bound(self.x)
 
     def cps_bound(self):
-        """
+        r"""
         The Cremona-Prickett-Siksek height bound for this elliptic curve.
 
         OUTPUT:
@@ -374,12 +374,11 @@ cdef class _Curvedata:   # cython class wrapping eclib's Curvedata class
         + B`, where `h(P)` is the naive height and `\hat{h}(P)` the
         canonical height.
 
-        .. note::
+        .. NOTE::
 
-            Since eclib can compute this to arbitrary precision, we
+            Since ``eclib`` can compute this to arbitrary precision, we
             could return a Sage real, but this is only a bound and in
-            the contexts in which it is used extra precision is
-            irrelevant.
+            the contexts in which it is used extra precision is irrelevant.
 
         EXAMPLES::
 
@@ -399,7 +398,7 @@ cdef class _Curvedata:   # cython class wrapping eclib's Curvedata class
         return x
 
     def height_constant(self):
-        """
+        r"""
         A height bound for this elliptic curve.
 
         OUTPUT:
@@ -410,12 +409,11 @@ cdef class _Curvedata:   # cython class wrapping eclib's Curvedata class
         canonical height.  This is the minimum of the Silverman and
         Cremona_Prickett-Siksek height bounds.
 
-        .. note::
+        .. NOTE::
 
-            Since eclib can compute this to arbitrary precision, we
+            Since ``eclib`` can compute this to arbitrary precision, we
             could return a Sage real, but this is only a bound and in
-            the contexts in which it is used extra precision is
-            irrelevant.
+            the contexts in which it is used extra precision is irrelevant.
 
         EXAMPLES::
 
@@ -542,7 +540,7 @@ cdef class _mw:
     cdef int verb
 
     def __init__(self, _Curvedata curve, verb=False, pp=1, maxr=999):
-        """
+        r"""
         Constructor for mw class.
 
         INPUT:
@@ -704,10 +702,10 @@ cdef class _mw:
 
         .. NOTE::
 
-           The eclib function which implements this only carries out
-           any saturation if the rank of the points increases upon
-           adding the new point.  This is because it is assumed that
-           one saturates as ones goes along.
+            The eclib function which implements this only carries out
+            any saturation if the rank of the points increases upon
+            adding the new point.  This is because it is assumed that
+            one saturates as ones goes along.
 
         EXAMPLES::
 
@@ -753,7 +751,7 @@ cdef class _mw:
 
     def getbasis(self):
         """
-        Returns the current basis of the mw structure.
+        Return the current basis of the mw structure.
 
         OUTPUT:
 
@@ -778,7 +776,7 @@ cdef class _mw:
 
     def regulator(self):
         """
-        Returns the regulator of the current basis of the mw group.
+        Return the regulator of the current basis of the mw group.
 
         OUTPUT:
 
@@ -810,7 +808,7 @@ cdef class _mw:
 
     def rank(self):
         """
-        Returns the rank of the current basis of the mw group.
+        Return the rank of the current basis of the mw group.
 
         OUTPUT:
 
@@ -908,7 +906,7 @@ cdef class _mw:
         return ok, index, unsat
 
     def search(self, h_lim, int moduli_option=0, int verb=0):
-        """
+        r"""
         Search for points in the mw group.
 
         INPUT:
@@ -926,17 +924,16 @@ cdef class _mw:
 
         .. NOTE::
 
-           The effect of the search is also governed by the class
-           options, notably whether the points found are processed:
-           meaning that linear relations are found and saturation is
-           carried out, with the result that the list of generators
-           will always contain a `\ZZ`-span of the saturation of the
-           points found, modulo torsion.
+            The effect of the search is also governed by the class
+            options, notably whether the points found are processed:
+            meaning that linear relations are found and saturation is
+            carried out, with the result that the list of generators
+            will always contain a `\ZZ`-span of the saturation of the
+            points found, modulo torsion.
 
         OUTPUT:
 
-        None.  The effect of the search is to update the list of
-        generators.
+        None. The effect of the search is to update the list of generators.
 
         EXAMPLES::
 
@@ -1069,7 +1066,7 @@ cdef class _two_descent:
 
     def getrank(self):
         """
-        Returns the rank (after doing a 2-descent).
+        Return the rank (after doing a 2-descent).
 
         OUTPUT:
 
@@ -1102,7 +1099,7 @@ cdef class _two_descent:
 
     def getrankbound(self):
         """
-        Returns the rank upper bound (after doing a 2-descent).
+        Return the rank upper bound (after doing a 2-descent).
 
         OUTPUT:
 
@@ -1135,7 +1132,7 @@ cdef class _two_descent:
 
     def getselmer(self):
         """
-        Returns the 2-Selmer rank (after doing a 2-descent).
+        Return the 2-Selmer rank (after doing a 2-descent).
 
         OUTPUT:
 
@@ -1167,7 +1164,7 @@ cdef class _two_descent:
 
     def ok(self):
         """
-        Returns the success flag (after doing a 2-descent).
+        Return the success flag (after doing a 2-descent).
 
         OUTPUT:
 
@@ -1196,7 +1193,7 @@ cdef class _two_descent:
 
     def getcertain(self):
         """
-        Returns the certainty flag (after doing a 2-descent).
+        Return the certainty flag (after doing a 2-descent).
 
         OUTPUT:
 
@@ -1273,16 +1270,17 @@ cdef class _two_descent:
         sig_off()
 
     def getbasis(self):
-        """
-        Returns the basis of points found by doing a 2-descent.
+        r"""
+        Return the basis of points found by doing a 2-descent.
 
         If the success and certain flags are 1, this will be a
         `\ZZ/2\ZZ`-basis for `E(\QQ)/2E(\QQ)` (modulo torsion),
         otherwise possibly only for a proper subgroup.
 
         .. NOTE::
 
-           You must call ``saturate()`` first, or a RunTimeError will be raised.
+            You must call ``saturate()`` first, or a ``RunTimeError``
+            will be raised.
 
         OUTPUT:
 
@@ -1320,7 +1318,7 @@ cdef class _two_descent:
 
     def regulator(self):
         """
-        Returns the regulator of the points found by doing a 2-descent.
+        Return the regulator of the points found by doing a 2-descent.
 
         OUTPUT:
 

src/sage/libs/eclib/newforms.pyx

@@ -22,7 +22,7 @@ from sage.modular.all import Cusp
 
 
 cdef class ECModularSymbol:
-    """
+    r"""
     Modular symbol associated with an elliptic curve,  using John Cremona's newforms class.
 
     EXAMPLES::

src/sage/libs/ntl/ntl_GF2.pyx

@@ -116,6 +116,8 @@ cdef class ntl_GF2():
 
     def __mul__(self, other):
         """
+        EXAMPLES::
+
             sage: o = ntl.GF2(1)
             sage: z = ntl.GF2(0)
             sage: o*o
@@ -137,6 +139,8 @@ cdef class ntl_GF2():
 
     def __truediv__(self, other):
         """
+        EXAMPLES::
+
             sage: o = ntl.GF2(1)
             sage: z = ntl.GF2(0)
             sage: o/o
@@ -159,6 +163,8 @@ cdef class ntl_GF2():
 
     def __sub__(self, other):
         """
+        EXAMPLES::
+
             sage: o = ntl.GF2(1)
             sage: z = ntl.GF2(0)
             sage: o-o
@@ -180,6 +186,8 @@ cdef class ntl_GF2():
 
     def __add__(self, other):
         """
+        EXAMPLES::
+
             sage: o = ntl.GF2(1)
             sage: z = ntl.GF2(0)
             sage: o+o
@@ -201,6 +209,8 @@ cdef class ntl_GF2():
 
     def __neg__(ntl_GF2 self):
         """
+        EXAMPLES::
+
             sage: o = ntl.GF2(1)
             sage: z = ntl.GF2(0)
             sage: -z
@@ -214,6 +224,8 @@ cdef class ntl_GF2():
 
     def __pow__(ntl_GF2 self, long e, ignored):
         """
+        EXAMPLES::
+
             sage: o = ntl.GF2(1)
             sage: z = ntl.GF2(0)
             sage: z^2

src/sage/libs/ntl/ntl_GF2E.pyx

@@ -5,7 +5,7 @@
 # distutils: extra_link_args = NTL_LIBEXTRA
 # distutils: language = c++
 
-#*****************************************************************************
+# ****************************************************************************
 #       Copyright (C) 2005 William Stein <[email protected]>
 #       Copyright (C) 2007 Martin Albrecht <[email protected]>
 #
@@ -18,8 +18,8 @@
 #
 #  The full text of the GPL is available at:
 #
-#                  http://www.gnu.org/licenses/
-#*****************************************************************************
+#                  https://www.gnu.org/licenses/
+# ****************************************************************************
 
 from sage.ext.cplusplus cimport ccrepr
 
@@ -73,7 +73,7 @@ def ntl_GF2E_random(ntl_GF2EContext_class ctx):
 
 cdef class ntl_GF2E():
     r"""
-    The \\class{GF2E} represents a finite extension field over GF(2)
+    The :class:`GF2E` represents a finite extension field over GF(2)
     using NTL. Elements are represented as polynomials over GF(2)
     modulo a modulus.
 
@@ -164,6 +164,8 @@ cdef class ntl_GF2E():
 
     def __reduce__(self):
         """
+        EXAMPLES::
+
             sage: ctx = ntl.GF2EContext( ntl.GF2X([1,1,0,1,1,0,0,0,1]) )
             sage: a = ntl.GF2E(ntl.ZZ_pX([1,1,3],2), ctx)
             sage: loads(dumps(a)) == a
@@ -439,17 +441,20 @@ cdef class ntl_GF2E():
         return l
 
     def _sage_(ntl_GF2E self, k=None):
-        """
-        Returns a \class{FiniteFieldElement} representation
-        of this element. If a \class{FiniteField} k is provided
-        it is constructed in this field if possible. A \class{FiniteField}
-        will be constructed if none is provided.
+        r"""
+        Return a :class:`FiniteFieldElement` representation of this element.
+
+        If a :class:`FiniteField` `k` is provided, it is constructed
+        in this field if possible. A :class:`FiniteField` will be
+        constructed if none is provided.
 
         INPUT:
-            k     -- optional GF(2**deg)
+
+        - `k` -- (optional) a field `\GF{2^d}`
 
         OUTPUT:
-            FiniteFieldElement over k
+
+        :class:`FiniteFieldElement` over `k`
 
         EXAMPLES::