Trac #34797: some formatting for NOTE:: blocks

mostly in pyx files

URL: https://trac.sagemath.org/34797
Reported by: chapoton
Ticket author(s): Frédéric Chapoton
Reviewer(s): David Coudert

Author: Release Manager

src/sage/geometry/newton_polygon.py

@@ -272,7 +272,7 @@ def __pow__(self, exp, ignored=None):
 
         This Newton polygon scaled by a factor ``exp``.
 
-        NOTE::
+        .. NOTE::
 
             If ``self`` is the Newton polygon of a polynomial `f`, then
             ``self^exp`` is the Newton polygon of `f^{exp}`.

src/sage/libs/linkages/padics/relaxed/flint.pxi

@@ -259,7 +259,7 @@ cdef inline void digit_smallest(cdigit res, cdigit carry, cdigit a, PowComputer_
     - ``a`` -- a ``cdigit``, the digit to reduce
     - ``prime_pow`` -- the PowComputer for the ring
 
-    NOTE::
+    .. NOTE::
 
         This function assumes that ``a`` is always reduced in the
         usual sense, that is belongs to the range `[0, p-1]`.
@@ -383,7 +383,7 @@ cdef inline void element_get_slice(fmpz_poly_t res, fmpz_poly_t x, slong start,
     - ``start`` -- an integer, the start position of the slice
     - ``length`` -- an integer, the length of the slice
 
-    NOTE::
+    .. NOTE::
 
         The function only sets up a pointer to the requested slice
         (the slice is not copied). Hence any future modification

src/sage/misc/latex_standalone.py

@@ -346,7 +346,7 @@ def _repr_(self):
 
         It contains the first few and last few lines of the content.
 
-        NOTE::
+        .. NOTE::
 
             Use ``print(t)`` or ``str(t)`` to show or get the full content.
 

src/sage/rings/padics/factory.py

@@ -2949,12 +2949,12 @@ def ZpLF(p, prec=None, *args, **kwds):
 
     See documentation for :func:`Zp` for a description of the input parameters.
 
-    NOTE:
+    .. NOTE::
 
-    The precision is tracked using automatic differentiation
-    techniques (see [CRV2018]_ and [CRV2014]_).
-    Floating point `p`-adic numbers are used for the computation
-    of the differential (which is then not exact).
+        The precision is tracked using automatic differentiation
+        techniques (see [CRV2018]_ and [CRV2014]_).
+        Floating point `p`-adic numbers are used for the computation
+        of the differential (which is then not exact).
 
     EXAMPLES::
 

src/sage/rings/padics/local_generic_element.pyx

@@ -737,10 +737,10 @@ cdef class LocalGenericElement(CommutativeRingElement):
 
         The square root or the list of all square roots of this element.
 
-        NOTE:
+        .. NOTE::
 
-        The square root is chosen (resp. the square roots are ordered) in
-        a deterministic way, which is compatible with change of precision.
+            The square root is chosen (resp. the square roots are ordered) in
+            a deterministic way, which is compatible with change of precision.
 
         EXAMPLES::
 

src/sage/rings/padics/padic_capped_absolute_element.pyx

@@ -320,7 +320,7 @@ cdef class pAdicCappedAbsoluteElement(CAElement):
           this valuation (and beyond) to see if they can contribute to the
           series.
 
-        NOTE::
+        .. NOTE::
 
             The function does not check that its argument ``self`` is
             1 in the residue field. If this assumption is not fulfilled

src/sage/rings/padics/padic_fixed_mod_element.pyx

@@ -389,7 +389,7 @@ cdef class pAdicFixedModElement(FMElement):
           this valuation (and beyond) to see if they can contribute to the
           series.
 
-        NOTE::
+        .. NOTE::
 
             The function does not check that its argument ``self`` is
             1 in the residue field. If this assumption is not fulfilled
@@ -459,7 +459,7 @@ cdef class pAdicFixedModElement(FMElement):
         - ``aprec`` -- an integer, the precision to which to compute the
           exponential
 
-        NOTE::
+        .. NOTE::
 
             The function does not check that its argument ``self`` is
             the disk of convergence of ``exp``. If this assumption is not
@@ -523,7 +523,7 @@ cdef class pAdicFixedModElement(FMElement):
           method. See :meth:`log` for more details about the possible
           algorithms.
 
-        NOTE::
+        .. NOTE::
 
             The function does not check that its argument ``self`` is
             the disk of convergence of ``exp``. If this assumption is not

src/sage/rings/padics/padic_generic_element.pyx

@@ -2004,7 +2004,10 @@ cdef class pAdicGenericElement(LocalGenericElement):
         - ``self`` -- a p-adic element
         - ``p`` -- a prime (default: None). If specified, will make sure that p==self.parent().prime()
 
-        NOTE: The optional argument p is used for consistency with the valuation methods on integer and rational.
+        .. NOTE::
+
+            The optional argument p is used for consistency with the valuation
+            methods on integer and rational.
 
         OUTPUT:
 
@@ -2126,8 +2129,10 @@ cdef class pAdicGenericElement(LocalGenericElement):
         - ``self`` -- a p-adic element
         - ``p`` -- a prime (default: ``None``). If specified, will make sure that ``p == self.parent().prime()``
 
-        NOTE: The optional argument p is used for consistency with the valuation methods on integer and rational.
+        .. NOTE::
 
+            The optional argument p is used for consistency with the valuation
+            methods on integer and rational.
 
         OUTPUT:
 
@@ -2456,7 +2461,7 @@ cdef class pAdicGenericElement(LocalGenericElement):
           this valuation (and beyond) to see if they can contribute to the
           series.
 
-        NOTE::
+        .. NOTE::
 
             The function does not check that its argument ``self`` is
             1 in the residue field. If this assumption is not fulfilled

src/sage/rings/tate_algebra.py

@@ -1147,7 +1147,7 @@ def precision_cap(self):
         """
         Return the precision cap of this Tate algebra.
 
-        NOTE::
+        .. NOTE::
 
             The precision cap is the truncation precision
             used for arithmetic operations computed by

src/sage/rings/tate_algebra_element.pyx

@@ -1715,9 +1715,9 @@ cdef class TateAlgebraElement(CommutativeAlgebraElement):
           the precision at which the result is computed, if ``None``,
           the result is truncated according to the cap of the parent
 
-        NOTE:
+        .. NOTE::
 
-        The ``n``-th root is computed as `\exp(\frac 1 n \log(f))`.
+            The ``n``-th root is computed as `\exp(\frac 1 n \log(f))`.
 
         EXAMPLES::
 
@@ -3318,7 +3318,7 @@ cdef class TateAlgebraElement(CommutativeAlgebraElement):
 
         - ``divisors`` -- a series, or a list of series
 
-        NOTE::
+        NOTE:
 
         The condition on the remainder is that it has