Skip to content

Commit 6a8faff

Browse files
author
Release Manager
committed
gh-40531: Improve documentation formatting <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes #12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes #12345". --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [ ] The title is concise and informative. - [ ] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - #12345: short description why this is a dependency --> <!-- - #34567: ... --> URL: #40531 Reported by: user202729 Reviewer(s):
2 parents faee909 + 6971890 commit 6a8faff

File tree

7 files changed

+11
-11
lines changed

7 files changed

+11
-11
lines changed

src/sage/combinat/designs/incidence_structures.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1707,7 +1707,7 @@ def is_generalized_quadrangle(self, verbose=False, parameters=False):
17071707
- ``verbose`` -- boolean; whether to print an explanation when the
17081708
instance is not a generalized quadrangle
17091709
1710-
- ``parameters`` -- (boolean; ``False``); if set to ``True``, the
1710+
- ``parameters`` -- boolean (default: ``False``); if set to ``True``, the
17111711
function returns a pair ``(s,t)`` instead of ``True`` answers. In this
17121712
case, `s` and `t` are the integers defined above if they exist (each
17131713
can be set to ``False`` otherwise).

src/sage/combinat/fully_packed_loop.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -760,7 +760,7 @@ def plot(self, **options):
760760
its order. Setting this option to ``True`` makes it unlikely to
761761
have two neighboring links with the same color.
762762
763-
- ``loop_fill`` -- (boolean, optional) whether to fill the interior of the loops
763+
- ``loop_fill`` -- boolean (default: ``False``); whether to fill the interior of the loops
764764
765765
EXAMPLES:
766766

src/sage/databases/oeis.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -246,11 +246,11 @@ class OEIS:
246246
- a list representing a sequence of integers.
247247
- a string, representing a text search.
248248
249-
- ``max_results`` -- (integer, default: 30) the maximum number of
249+
- ``max_results`` -- integer (default: 30); the maximum number of
250250
results to return, they are sorted according to their relevance. In
251251
any cases, the OEIS website will never provide more than 100 results.
252252
253-
- ``first_result`` -- (integer, default: 0) allow to skip the
253+
- ``first_result`` -- integer (default: 0); allow to skip the
254254
``first_result`` first results in the search, to go further.
255255
This is useful if you are looking for a sequence that may appear
256256
after the 100 first found sequences.
@@ -448,11 +448,11 @@ def find_by_description(self, description, max_results=3, first_result=0):
448448
449449
- ``description`` -- string; the description the searched sequences
450450
451-
- ``max_results`` -- (integer, default: 3) the maximum number of results
451+
- ``max_results`` -- integer (default: 3); the maximum number of results
452452
we want. In any case, the on-line encyclopedia will not return more
453453
than 100 results.
454454
455-
- ``first_result`` -- (integer, default: 0) allow to skip the
455+
- ``first_result`` -- integer (default: 0); allow to skip the
456456
``first_result`` first results in the search, to go further.
457457
This is useful if you are looking for a sequence that may appear
458458
after the 100 first found sequences.

src/sage/doctest/control.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ class DocTestDefaults(SageObject):
6868
6969
INPUT:
7070
71-
- ``runtest_default`` -- (boolean, default ``False``); if ``True``,
71+
- ``runtest_default`` -- boolean (default: ``False``); if ``True``,
7272
fills in attribute to be the same as the defaults defined in
7373
``sage-runtests``. If ``False``, change defaults in a few places
7474
for use in doctests of the doctester, which is mostly to make

src/sage/parallel/map_reduce.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@
230230
via parameters passed to the :meth:`RESetMapReduce.run` method.
231231
The following three parameters can be used:
232232
233-
- ``max_proc`` -- (integer, default: ``None``) if given, the
233+
- ``max_proc`` -- integer (default: ``None``); if given, the
234234
maximum number of worker processors to use. The actual number
235235
is also bounded by the value of the environment variable
236236
``SAGE_NUM_THREADS`` (the number of cores by default).
@@ -1409,7 +1409,7 @@ def run(self,
14091409
14101410
INPUT:
14111411
1412-
- ``max_proc`` -- (integer, default: ``None``) if given, the
1412+
- ``max_proc`` -- integer (default: ``None``); if given, the
14131413
maximum number of worker processors to use. The actual number
14141414
is also bounded by the value of the environment variable
14151415
``SAGE_NUM_THREADS`` (the number of cores by default).

src/sage/rings/padics/pow_computer_flint.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -605,7 +605,7 @@ def PowComputer_flint_maker(prime, cache_limit, prec_cap, ram_prec_cap, in_field
605605
``ram_prec_cap`` and ``prec_cap`` is that
606606
``prec_cap = ceil(n/e)``
607607
608-
- ``in_field`` -- (boolean) whether the associated ring is
608+
- ``in_field`` -- boolean; whether the associated ring is
609609
actually a field
610610
611611
- ``poly`` -- the polynomial defining the extension

src/sage/schemes/elliptic_curves/hom_composite.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -974,7 +974,7 @@ def inverse_image(self, Q, /, *, all=False):
974974
INPUT:
975975
976976
- ``Q`` -- a point
977-
- ``all`` -- (boolean) if ``True``, returns an iterator over all points
977+
- ``all`` -- boolean; if ``True``, returns an iterator over all points
978978
in the inverse image
979979
980980
EXAMPLES::

0 commit comments

Comments
 (0)