Docstring suggestions by kwankyu

gmou3 · gmou3 · commit 41893fdfed0c · 2024-07-07T08:08:46.000Z
For commits d4a3ce9 and 8f00496.
diff --git a/src/sage/algebras/steenrod/steenrod_algebra_bases.py b/src/sage/algebras/steenrod/steenrod_algebra_bases.py
@@ -269,8 +269,8 @@ def steenrod_algebra_basis(n, basis='milnor', p=2, **kwds):
     - ``profile`` -- profile function (default: ``None``); this
       is just passed on to the functions :func:`milnor_basis` and
       :func:`pst_basis`
-    - ``truncation_type`` -- truncation type, either 0 or Infinity
-      (default: Infinity if no profile function is specified,
+    - ``truncation_type`` -- truncation type, either 0 or ``Infinity``
+      (default: ``Infinity`` if no profile function is specified,
       0 otherwise).  This is just passed on to the function
       :func:`milnor_basis`.
     - ``generic`` -- boolean (default: ``None``)
@@ -525,8 +525,8 @@ def milnor_basis(n, p=2, **kwds):
       :func:`SteenrodAlgebra <sage.algebras.steenrod.steenrod_algebra.SteenrodAlgebra>`
       for information on profile functions.
 
-    - ``truncation_type`` -- truncation type, either 0 or Infinity
-      (default: Infinity if no profile function is specified,
+    - ``truncation_type`` -- truncation type, either 0 or ``Infinity``
+      (default: ``Infinity`` if no profile function is specified,
       0 otherwise)
 
     OUTPUT: tuple of mod `p` Milnor basis elements in dimension `n`
@@ -774,8 +774,8 @@ def atomic_basis(n, basis, **kwds):
       :mod:`sage.algebras.steenrod.steenrod_algebra` and
       :func:`SteenrodAlgebra` for information on profile functions.
 
-    - ``truncation_type`` -- truncation type, either 0 or Infinity
-      (default: Infinity if no profile function is specified,
+    - ``truncation_type`` -- truncation type, either 0 or ``Infinity``
+      (default: ``Infinity`` if no profile function is specified,
       0 otherwise).
 
     OUTPUT: tuple of basis elements in dimension `n`
@@ -1005,8 +1005,8 @@ def atomic_basis_odd(n, basis, p, **kwds):
       :mod:`sage.algebras.steenrod.steenrod_algebra` and
       :func:`SteenrodAlgebra` for information on profile functions.
 
-    - ``truncation_type`` -- truncation type, either 0 or Infinity
-      (default: Infinity if no profile function is specified,
+    - ``truncation_type`` -- truncation type, either 0 or ``Infinity``
+      (default: ``Infinity`` if no profile function is specified,
       0 otherwise).
 
     OUTPUT: tuple of basis elements in dimension `n`
diff --git a/src/sage/combinat/ranker.py b/src/sage/combinat/ranker.py
@@ -181,7 +181,7 @@ def unrank(L, i):
     INPUT:
 
     - ``L`` -- list, tuple, finite enumerated set, etc.
-    - ``i`` -- integer or :class:`Integer`
+    - ``i`` -- integer
 
     The purpose of this utility is to give a uniform idiom to recover
     the `i`-th element of an object ``L``, whether ``L`` is a list,
diff --git a/src/sage/schemes/berkovich/berkovich_cp_element.py b/src/sage/schemes/berkovich/berkovich_cp_element.py
@@ -610,7 +610,7 @@ def diameter(self, basepoint=Infinity):
 
         INPUT:
 
-        - ``basepoint`` -- (default: Infinity) a point of the
+        - ``basepoint`` -- (default: ``Infinity``) a point of the
           same Berkovich space as this point
 
         OUTPUT: a real number
@@ -1555,8 +1555,8 @@ def join(self, other, basepoint=Infinity):
         INPUT:
 
         - ``other`` -- a point of the same Berkovich space as this point
-        - ``basepoint`` -- (default: Infinity) a point of the same
-          Berkovich space as this point or Infinity
+        - ``basepoint`` -- (default: ``Infinity``) a point of the same
+          Berkovich space as this point or ``Infinity``
 
         OUTPUT: a point of the same Berkovich space
 
@@ -2238,8 +2238,8 @@ def join(self, other, basepoint=Infinity):
         INPUT:
 
         - ``other`` -- a point of the same Berkovich space as this point
-        - ``basepoint`` -- (default: Infinity) a point of the same
-          Berkovich space as this point, or infinity
+        - ``basepoint`` -- (default: ``Infinity``) a point of the same
+          Berkovich space as this point, or ``Infinity``
 
         OUTPUT: a point of the same Berkovich space
 
diff --git a/src/sage/schemes/elliptic_curves/ell_curve_isogeny.py b/src/sage/schemes/elliptic_curves/ell_curve_isogeny.py
@@ -274,7 +274,7 @@ def compute_vw_kohel_even_deg1(x0, y0, a1, a2, a4):
 
     - ``a1``, ``a2``, ``a4`` -- invariants of `E`
 
-    OUTPUT: tuple) Vélu's isogeny parameters `(v,w)`.
+    OUTPUT: Vélu's isogeny parameters `(v,w)`.
 
     EXAMPLES:
 
@@ -310,7 +310,7 @@ def compute_vw_kohel_even_deg3(b2, b4, s1, s2, s3):
     - ``s1``, ``s2``, ``s3`` -- signed coefficients of the 2-division
       polynomial of `E`
 
-    OUTPUT: tuple) Vélu's isogeny parameters `(v,w)`.
+    OUTPUT: Vélu's isogeny parameters `(v,w)`.
 
     EXAMPLES:
 
@@ -349,7 +349,7 @@ def compute_vw_kohel_odd(b2, b4, b6, s1, s2, s3, n):
 
     - ``n`` -- integer; the degree
 
-    OUTPUT: tuple; Vélu's isogeny parameters `(v,w)`
+    OUTPUT: Vélu's isogeny parameters `(v,w)`
 
     EXAMPLES:
 
diff --git a/src/sage/schemes/elliptic_curves/ell_local_data.py b/src/sage/schemes/elliptic_curves/ell_local_data.py
@@ -165,7 +165,7 @@ def __init__(self, E, P, proof=None, algorithm='pari', globally=False):
 
         - ``P`` -- a prime ideal of the field, or a prime integer if the field is `\QQ`
 
-        - ``proof`` -- bool-- if ``True``, only use provably correct
+        - ``proof`` -- boolean; if ``True``, only use provably correct
           methods (default: controlled by global proof module).  Note
           that the proof module is number_field, not elliptic_curves,
           since the functions that actually need the flag are in
@@ -508,7 +508,7 @@ def bad_reduction_type(self):
 
         OUTPUT:
 
-        (int or ``None``):
+        integer or ``None``:
 
         - +1 for split multiplicative reduction
         - -1 for non-split multiplicative reduction
@@ -697,7 +697,7 @@ def _tate(self, proof=None, globally=False):
 
         (tuple) ``(Emin, p, val_disc, fp, KS, cp)`` where:
 
-        - ``Emin`` -- EllipticCurve; a model (integral and) minimal at P
+        - ``Emin`` -- :class:`EllipticCurve`; a model (integral and) minimal at P
         - ``p`` -- integer; the residue characteristic
         - ``val_disc`` -- integer; the valuation of the local minimal discriminant
         - ``fp`` -- integer; the valuation of the conductor
diff --git a/src/sage/schemes/elliptic_curves/ell_number_field.py b/src/sage/schemes/elliptic_curves/ell_number_field.py
@@ -844,7 +844,7 @@ def local_data(self, P=None, proof=None, algorithm='pari', globally=False):
 
         INPUT:
 
-        - ``P`` -- either None, a prime ideal of the base field of ``self``,
+        - ``P`` -- either ``None``, a prime ideal of the base field of ``self``,
           or an element of the base field that generates a prime ideal
 
         - ``proof`` -- whether to only use provably correct methods
diff --git a/src/sage/schemes/elliptic_curves/ell_point.py b/src/sage/schemes/elliptic_curves/ell_point.py
@@ -1485,12 +1485,12 @@ def _line_(self, R, Q):
 
         INPUT:
 
-        - ``R``, ``Q`` -- points on ``self.curve()`` with ``Q`` nonzero
+        - ``R``, ``Q`` -- points on ``self.curve()`` with `Q` nonzero
 
         OUTPUT:
 
         An element of the base field ``self.curve().base_field()``.
-        A :exc:`ValueError` is raised if ``Q`` is zero.`
+        A :exc:`ValueError` is raised if `Q` is zero.
 
         EXAMPLES::
 
diff --git a/src/sage/schemes/elliptic_curves/gal_reps_number_field.py b/src/sage/schemes/elliptic_curves/gal_reps_number_field.py
@@ -427,7 +427,7 @@ def _non_surjective(E, patience=100):
 
     INPUT:
 
-    - ``E`` -- EllipticCurve (over a number field)
+    - ``E`` -- :class:`EllipticCurve` (over a number field)
 
     - ``A`` -- integer; a bound on the number of traces of Frobenius to use
       while trying to prove surjectivity
@@ -500,7 +500,7 @@ def Frobenius_filter(E, L, patience=100):
 
     INPUT:
 
-    - ``E`` -- EllipticCurve over a number field
+    - ``E`` -- :class:`EllipticCurve` over a number field
 
     - ``L`` -- list of prime numbers
 
@@ -599,7 +599,7 @@ def _exceptionals(E, L, patience=1000):
 
     INPUT:
 
-    - ``E`` -- EllipticCurve over a number field
+    - ``E`` -- :class:`EllipticCurve` over a number field
 
     - ``L`` -- list of prime numbers
 
@@ -748,7 +748,7 @@ def _over_numberfield(E):
 
     INPUT:
 
-    - ``E`` -- EllipticCurve over a number field
+    - ``E`` -- :class:`EllipticCurve` over a number field
 
     OUTPUT:
 
@@ -827,7 +827,7 @@ def _semistable_reducible_primes(E, verbose=False):
 
     INPUT:
 
-    - ``E`` -- EllipticCurve over a number field
+    - ``E`` -- :class:`EllipticCurve` over a number field
 
     OUTPUT:
 
@@ -1003,7 +1003,7 @@ def _possible_normalizers(E, SA):
 
     INPUT:
 
-    - ``E`` -- EllipticCurve over a number field K
+    - ``E`` -- :class:`EllipticCurve` over a number field K
 
     - ``SA`` -- list of primes of K
 
diff --git a/src/sage/schemes/elliptic_curves/isogeny_small_degree.py b/src/sage/schemes/elliptic_curves/isogeny_small_degree.py
@@ -2039,8 +2039,8 @@ def isogenies_prime_degree_genus_plus_0(E, l=None, minimal_models=True):
 
     psi = Fxuv(Psi2(l))
     for u0, v0 in S:
-        A4 = Fuv(data['A4'])(u0,v0) #nonzero since j!=0
-        A6 = Fuv(data['A6'])(u0,v0) #nonzero since j!=1728
+        A4 = Fuv(data['A4'])(u0,v0)  # nonzero since j!=0
+        A6 = Fuv(data['A6'])(u0,v0)  # nonzero since j!=1728
         T = (c4*A6)/(2*c6*A4)
         kernels += [psi((36*X+3*b2)*T,u0,v0).monic()]
     return [E.isogeny(ker) for ker in kernels]
diff --git a/src/sage/schemes/elliptic_curves/period_lattice_region.pyx b/src/sage/schemes/elliptic_curves/period_lattice_region.pyx
@@ -187,7 +187,7 @@ cdef class PeriodicRegion:
 
         INPUT:
 
-        - ``condition`` -- function, (default: ``None``); if not ``None``, only
+        - ``condition`` -- function (default: ``None``); if not ``None``, only
           keep tiles in the refinement which satisfy the condition
 
         - ``times`` -- integer (default: 1); the number of times to refine.
diff --git a/src/sage/schemes/elliptic_curves/sha_tate.py b/src/sage/schemes/elliptic_curves/sha_tate.py
@@ -928,7 +928,7 @@ def bound_kolyvagin(self, D=0, regulator=None,
           analytic rank greater than 2 (in which case we return 0)
 
         - ``index`` -- the odd part of the index of the Heegner point in the full
-          group of `K`-rational points on (if `E` has CM, returns 0)
+          group of `K`-rational points on `E` (if `E` has CM, returns 0)
 
         REMARKS:
 
diff --git a/src/sage/schemes/elliptic_curves/weierstrass_morphism.py b/src/sage/schemes/elliptic_curves/weierstrass_morphism.py
@@ -225,7 +225,7 @@ def _isomorphisms(E, F):
 
     INPUT:
 
-    - ``E``, ``F`` -- EllipticCurve; Two elliptic curves
+    - ``E``, ``F`` -- two elliptic curves
 
     OUTPUT:
 
diff --git a/src/sage/schemes/hyperelliptic_curves/hyperelliptic_finite_field.py b/src/sage/schemes/hyperelliptic_curves/hyperelliptic_finite_field.py
@@ -1441,12 +1441,12 @@ def _Cartier_matrix_cached(self):
         r"""
         INPUT:
 
-        - Hyperelliptic Curve of the form `y^2 = f(x)` over a finite field,
-          `\GF{q}`
+        - ``self`` -- Hyperelliptic Curve of the form `y^2 = f(x)` over a
+          finite field, `\GF{q}`
 
         OUTPUT:
 
-        - matrix(Fq,M)' The matrix `M = (c_(pi-j)), f(x)^((p-1)/2) = \sum c_i x^i`
+        - 'matrix(Fq,M)' The matrix `M = (c_(pi-j)), f(x)^((p-1)/2) = \sum c_i x^i`
         - 'Coeff' List of Coeffs of F, this is needed for Hasse-Witt function.
         - 'g' genus of the curve self, this is needed by a-number.
         - 'Fq' is the base field of self, and it is needed for Hasse-Witt
@@ -1576,12 +1576,13 @@ def Cartier_matrix(self):
         r"""
         INPUT:
 
-        - Hyperelliptic Curve of the form `y^2 = f(x)` over a finite field, `\GF{q}`
+        - ``self`` -- Hyperelliptic Curve of the form `y^2 = f(x)` over a
+          finite field, `\GF{q}`
 
         OUTPUT:
 
-        - ``M`` -- the matrix `M = (c_{pi-j})`, where `c_i` are the
-          coefficients of  `f(x)^{(p-1)/2} = \sum c_i x^i`
+        The matrix `M = (c_{pi-j})`, where `c_i` are the coefficients of
+        `f(x)^{(p-1)/2} = \sum c_i x^i`.
 
         REFERENCES:
 
@@ -1775,11 +1776,13 @@ def Hasse_Witt(self):
         r"""
         INPUT:
 
-        - Hyperelliptic Curve of the form `y^2 = f(x)` over a finite field, `\GF{q}`
+        - ``self`` -- Hyperelliptic Curve of the form `y^2 = f(x)` over a
+          finite field, `\GF{q}`
 
         OUTPUT:
 
-        - ``N`` : The matrix `N = M M^p \dots M^{p^{g-1}}` where `M = c_{pi-j}`, and `f(x)^{(p-1)/2} = \sum c_i x^i`
+        The matrix `N = M M^p \dots M^{p^{g-1}}` where `M = c_{pi-j}`, and
+        `f(x)^{(p-1)/2} = \sum c_i x^i`.
 
         Reference-N. Yui. On the Jacobian varieties of hyperelliptic curves over fields of characteristic `p > 2`.
 
@@ -1832,9 +1835,10 @@ def a_number(self):
         r"""
         INPUT:
 
-        - Hyperelliptic Curve of the form `y^2 = f(x)` over a finite field, `\GF{q}`
+        - ``self`` -- Hyperelliptic Curve of the form `y^2 = f(x)` over a
+          finite field, `\GF{q}`
 
-        OUTPUT: ``a``; a-number
+        OUTPUT: a-number
 
         EXAMPLES::
 
@@ -1871,9 +1875,10 @@ def p_rank(self):
         r"""
         INPUT:
 
-        - Hyperelliptic Curve of the form `y^2 = f(x)` over a finite field, `\GF{q}`
+        - ``self`` -- Hyperelliptic Curve of the form `y^2 = f(x)` over a
+          finite field, `\GF{q}`
 
-        OUTPUT: ``pr``; p-rank
+        OUTPUT: p-rank
 
         EXAMPLES::
 
diff --git a/src/sage/schemes/hyperelliptic_curves/hyperelliptic_padic_field.py b/src/sage/schemes/hyperelliptic_curves/hyperelliptic_padic_field.py
@@ -478,7 +478,7 @@ def coleman_integrals_on_basis(self, P, Q, algorithm=None):
 
         - ``P`` -- point on ``self``
         - ``Q`` -- point on ``self``
-        - ``algorithm`` -- (default: ``None``, uses Frobenius) or teichmuller
+        - ``algorithm`` -- ``None`` (default, uses Frobenius) or teichmuller
           (uses Teichmuller points)
 
         OUTPUT: the Coleman integrals `\{\int_P^Q x^i dx/2y \}_{i=0}^{2g-1}`
@@ -702,7 +702,7 @@ def coleman_integral(self, w, P, Q, algorithm='None'):
         - ``w`` -- differential (if one of P,Q is Weierstrass, w must be odd)
         - ``P`` -- point on ``self``
         - ``Q`` -- point on ``self``
-        - ``algorithm`` -- (default: ``None``, uses Frobenius) or teichmuller
+        - ``algorithm`` -- ``None`` (default, uses Frobenius) or teichmuller
           (uses Teichmuller points)
 
         OUTPUT: the Coleman integral `\int_P^Q w`
diff --git a/src/sage/schemes/hyperelliptic_curves/monsky_washnitzer.py b/src/sage/schemes/hyperelliptic_curves/monsky_washnitzer.py
@@ -664,7 +664,7 @@ def transpose_list(input) -> list[list]:
 
     - ``input`` -- list of lists, each list of the same length
 
-    OUTPUT: ``output``; list of lists such that ``output[i][j] = input[j][i]``
+    OUTPUT: list of lists such that ``output[i][j] = input[j][i]``
 
     EXAMPLES::
 
diff --git a/src/sage/schemes/plane_conics/con_rational_function_field.py b/src/sage/schemes/plane_conics/con_rational_function_field.py
@@ -435,7 +435,7 @@ def find_point(self, supports, roots, case, solution=0):
           ``supports[i]``, in the same order
         - ``case`` -- 1 or 0, as in [HC2006]_
         - ``solution`` -- (default: 0) a solution of (5) in [HC2006]_, if
-          ``case=0``, 0 otherwise
+          ``case`` = 0, 0 otherwise
 
         OUTPUT:
 
