From 69718908efdcd3beb83d430d9bc2852f4f640cf1 Mon Sep 17 00:00:00 2001 From: user202729 <25191436+user202729@users.noreply.github.com> Date: Sun, 3 Aug 2025 14:23:49 +0700 Subject: [PATCH] Improve documentation formatting --- src/sage/combinat/designs/incidence_structures.py | 2 +- src/sage/combinat/fully_packed_loop.py | 2 +- src/sage/databases/oeis.py | 8 ++++---- src/sage/doctest/control.py | 2 +- src/sage/parallel/map_reduce.py | 4 ++-- src/sage/rings/padics/pow_computer_flint.pyx | 2 +- src/sage/schemes/elliptic_curves/hom_composite.py | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/sage/combinat/designs/incidence_structures.py b/src/sage/combinat/designs/incidence_structures.py index 3c6170e1ea3..fe7545958f1 100644 --- a/src/sage/combinat/designs/incidence_structures.py +++ b/src/sage/combinat/designs/incidence_structures.py @@ -1707,7 +1707,7 @@ def is_generalized_quadrangle(self, verbose=False, parameters=False): - ``verbose`` -- boolean; whether to print an explanation when the instance is not a generalized quadrangle - - ``parameters`` -- (boolean; ``False``); if set to ``True``, the + - ``parameters`` -- boolean (default: ``False``); if set to ``True``, the function returns a pair ``(s,t)`` instead of ``True`` answers. In this case, `s` and `t` are the integers defined above if they exist (each can be set to ``False`` otherwise). diff --git a/src/sage/combinat/fully_packed_loop.py b/src/sage/combinat/fully_packed_loop.py index fc09d5952e9..9aee6da8c45 100644 --- a/src/sage/combinat/fully_packed_loop.py +++ b/src/sage/combinat/fully_packed_loop.py @@ -760,7 +760,7 @@ def plot(self, **options): its order. Setting this option to ``True`` makes it unlikely to have two neighboring links with the same color. - - ``loop_fill`` -- (boolean, optional) whether to fill the interior of the loops + - ``loop_fill`` -- boolean (default: ``False``); whether to fill the interior of the loops EXAMPLES: diff --git a/src/sage/databases/oeis.py b/src/sage/databases/oeis.py index d7310b26da1..f4c7df11cd6 100644 --- a/src/sage/databases/oeis.py +++ b/src/sage/databases/oeis.py @@ -246,11 +246,11 @@ class OEIS: - a list representing a sequence of integers. - a string, representing a text search. - - ``max_results`` -- (integer, default: 30) the maximum number of + - ``max_results`` -- integer (default: 30); the maximum number of results to return, they are sorted according to their relevance. In any cases, the OEIS website will never provide more than 100 results. - - ``first_result`` -- (integer, default: 0) allow to skip the + - ``first_result`` -- integer (default: 0); allow to skip the ``first_result`` first results in the search, to go further. This is useful if you are looking for a sequence that may appear after the 100 first found sequences. @@ -448,11 +448,11 @@ def find_by_description(self, description, max_results=3, first_result=0): - ``description`` -- string; the description the searched sequences - - ``max_results`` -- (integer, default: 3) the maximum number of results + - ``max_results`` -- integer (default: 3); the maximum number of results we want. In any case, the on-line encyclopedia will not return more than 100 results. - - ``first_result`` -- (integer, default: 0) allow to skip the + - ``first_result`` -- integer (default: 0); allow to skip the ``first_result`` first results in the search, to go further. This is useful if you are looking for a sequence that may appear after the 100 first found sequences. diff --git a/src/sage/doctest/control.py b/src/sage/doctest/control.py index 441e256292d..f1a50bb3a70 100644 --- a/src/sage/doctest/control.py +++ b/src/sage/doctest/control.py @@ -69,7 +69,7 @@ class DocTestDefaults(SageObject): INPUT: - - ``runtest_default`` -- (boolean, default ``False``); if ``True``, + - ``runtest_default`` -- boolean (default: ``False``); if ``True``, fills in attribute to be the same as the defaults defined in ``sage-runtests``. If ``False``, change defaults in a few places for use in doctests of the doctester, which is mostly to make diff --git a/src/sage/parallel/map_reduce.py b/src/sage/parallel/map_reduce.py index a182a136a2f..f62ed36fc31 100644 --- a/src/sage/parallel/map_reduce.py +++ b/src/sage/parallel/map_reduce.py @@ -230,7 +230,7 @@ via parameters passed to the :meth:`RESetMapReduce.run` method. The following three parameters can be used: -- ``max_proc`` -- (integer, default: ``None``) if given, the +- ``max_proc`` -- integer (default: ``None``); if given, the maximum number of worker processors to use. The actual number is also bounded by the value of the environment variable ``SAGE_NUM_THREADS`` (the number of cores by default). @@ -1409,7 +1409,7 @@ def run(self, INPUT: - - ``max_proc`` -- (integer, default: ``None``) if given, the + - ``max_proc`` -- integer (default: ``None``); if given, the maximum number of worker processors to use. The actual number is also bounded by the value of the environment variable ``SAGE_NUM_THREADS`` (the number of cores by default). diff --git a/src/sage/rings/padics/pow_computer_flint.pyx b/src/sage/rings/padics/pow_computer_flint.pyx index 8810b0b4d6d..1cc18db0748 100644 --- a/src/sage/rings/padics/pow_computer_flint.pyx +++ b/src/sage/rings/padics/pow_computer_flint.pyx @@ -605,7 +605,7 @@ def PowComputer_flint_maker(prime, cache_limit, prec_cap, ram_prec_cap, in_field ``ram_prec_cap`` and ``prec_cap`` is that ``prec_cap = ceil(n/e)`` - - ``in_field`` -- (boolean) whether the associated ring is + - ``in_field`` -- boolean; whether the associated ring is actually a field - ``poly`` -- the polynomial defining the extension diff --git a/src/sage/schemes/elliptic_curves/hom_composite.py b/src/sage/schemes/elliptic_curves/hom_composite.py index edcca9f7269..7f266a1c18e 100644 --- a/src/sage/schemes/elliptic_curves/hom_composite.py +++ b/src/sage/schemes/elliptic_curves/hom_composite.py @@ -974,7 +974,7 @@ def inverse_image(self, Q, /, *, all=False): INPUT: - ``Q`` -- a point - - ``all`` -- (boolean) if ``True``, returns an iterator over all points + - ``all`` -- boolean; if ``True``, returns an iterator over all points in the inverse image EXAMPLES::