Skip to content

Improve documentation formatting #40531

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/sage/combinat/designs/incidence_structures.py
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion src/sage/combinat/fully_packed_loop.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
8 changes: 4 additions & 4 deletions src/sage/databases/oeis.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/sage/doctest/control.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/sage/parallel/map_reduce.py
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion src/sage/rings/padics/pow_computer_flint.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/sage/schemes/elliptic_curves/hom_composite.py
Original file line number Diff line number Diff line change
Expand Up @@ -194,13 +194,13 @@
sage: phis = hom_composite._compute_factored_isogeny_prime_power(P,l,n)
sage: phis == hom_composite._compute_factored_isogeny_prime_power(P,l,n, split=0) # long time -- about 10s
True
sage: phis == hom_composite._compute_factored_isogeny_prime_power(P,l,n, split=0.1)

Check warning on line 197 in src/sage/schemes/elliptic_curves/hom_composite.py

View workflow job for this annotation

GitHub Actions / Conda (macos, Python 3.11, all)

Warning: slow doctest:

slow doctest:: Test ran for 19.40s cpu, 24.98s wall Check ran for 0.00s cpu, 0.00s wall

Check warning on line 197 in src/sage/schemes/elliptic_curves/hom_composite.py

View workflow job for this annotation

GitHub Actions / Conda (macos, Python 3.12, all)

Warning: slow doctest:

slow doctest:: Test ran for 19.70s cpu, 25.43s wall Check ran for 0.00s cpu, 0.00s wall
True
sage: phis == hom_composite._compute_factored_isogeny_prime_power(P,l,n, split=0.5)

Check warning on line 199 in src/sage/schemes/elliptic_curves/hom_composite.py

View workflow job for this annotation

GitHub Actions / Conda (macos, Python 3.11, all)

Warning: slow doctest:

slow doctest:: Test ran for 9.26s cpu, 13.59s wall Check ran for 0.00s cpu, 0.00s wall

Check warning on line 199 in src/sage/schemes/elliptic_curves/hom_composite.py

View workflow job for this annotation

GitHub Actions / Conda (macos, Python 3.12, all)

Warning: slow doctest:

slow doctest:: Test ran for 9.29s cpu, 13.64s wall Check ran for 0.00s cpu, 0.00s wall
True
sage: phis == hom_composite._compute_factored_isogeny_prime_power(P,l,n, split=0.9)

Check warning on line 201 in src/sage/schemes/elliptic_curves/hom_composite.py

View workflow job for this annotation

GitHub Actions / Conda (macos, Python 3.11, all)

Warning: slow doctest:

slow doctest:: Test ran for 10.11s cpu, 15.18s wall Check ran for 0.00s cpu, 0.00s wall

Check warning on line 201 in src/sage/schemes/elliptic_curves/hom_composite.py

View workflow job for this annotation

GitHub Actions / Conda (macos, Python 3.12, all)

Warning: slow doctest:

slow doctest:: Test ran for 8.16s cpu, 11.72s wall Check ran for 0.00s cpu, 0.00s wall
True
sage: phis == hom_composite._compute_factored_isogeny_prime_power(P,l,n, split=1)

Check warning on line 203 in src/sage/schemes/elliptic_curves/hom_composite.py

View workflow job for this annotation

GitHub Actions / Conda (macos, Python 3.11, all)

Warning: slow doctest:

slow doctest:: Test ran for 9.13s cpu, 12.70s wall Check ran for 0.00s cpu, 0.00s wall
True
"""
def rec(Q, k):
Expand Down Expand Up @@ -974,7 +974,7 @@
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::
Expand Down
Loading