Skip to content

Commit aaf8cc8

Browse files
gmou3gmou3
committed
Docstring edits
Work in `misc`.
1 parent 1669486 commit aaf8cc8

106 files changed

Lines changed: 982 additions & 1166 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎src/sage/algebras/hecke_algebras/cubic_hecke_algebra.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2969,7 +2969,7 @@ def cubic_equation(self, var='h', as_coefficients=False, generic=False):
29692969
29702970
INPUT:
29712971
2972-
- ``var`` -- string (default: ``'h'``) setting the indeterminate of the
2972+
- ``var`` -- string (default: ``'h'``); setting the indeterminate of the
29732973
equation
29742974
- ``as_coefficients`` -- boolean (default: ``False``); if set to ``True``
29752975
the list of coefficients is returned

‎src/sage/arith/misc.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3084,7 +3084,7 @@ def __repr__(self):
30843084

30853085
def __call__(self, n):
30863086
"""
3087-
Calls the euler_phi function.
3087+
Call the ``euler_phi`` function.
30883088
30893089
EXAMPLES::
30903090

‎src/sage/categories/action.pyx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ cdef class Action(Functor):
8585
8686
- ``S`` -- a parent or Python type
8787
88-
- ``is_left`` -- (boolean, default: ``True``) whether elements of
88+
- ``is_left`` -- boolean (default: ``True``); whether elements of
8989
``G`` are on the left
9090
9191
- ``op`` -- (default: ``None``) operation. This is not used by

‎src/sage/categories/finite_posets.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1890,7 +1890,7 @@ def order_ideals_lattice(self, as_ideals=True, facade=None):
18901890
18911891
INPUT:
18921892
1893-
- ``as_ideals`` -- boolean (default: ``True``), if ``True`` returns
1893+
- ``as_ideals`` -- boolean (default: ``True``); if ``True`` returns
18941894
a poset on the set of order ideals, otherwise on the set
18951895
of antichains
18961896
- ``facade`` -- boolean or ``None`` (default); whether to

‎src/sage/categories/pushout.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1864,7 +1864,8 @@ def __init__(self, n=None, is_sparse=False, inner_product_matrix=None, *,
18641864
INPUT:
18651865
18661866
- ``n`` -- the rank of the to-be-created modules (nonnegative integer)
1867-
- ``is_sparse`` -- boolean (default: ``False``), create sparse implementation of modules
1867+
- ``is_sparse`` -- boolean (default: ``False``); create sparse
1868+
implementation of modules
18681869
- ``inner_product_matrix`` -- ``n`` by ``n`` matrix, used to compute inner products in the
18691870
to-be-created modules
18701871
- ``name_mapping``, ``latex_name_mapping`` -- Dictionaries from base rings to names

‎src/sage/coding/cyclic_code.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ def bch_bound(n, D, arithmetic=False):
150150
151151
- ``D`` -- list of integers
152152
153-
- ``arithmetic`` -- (default: ``False``), if it is set to ``True``, then it
153+
- ``arithmetic`` -- (default: ``False``); if it is set to ``True``, then it
154154
computes the BCH bound using the longest arithmetic sequence definition
155155
156156
OUTPUT:
@@ -763,7 +763,7 @@ def bch_bound(self, arithmetic=False):
763763
764764
INPUT:
765765
766-
- ``arithmetic`` -- (default: ``False``), if it is set to ``True``,
766+
- ``arithmetic`` -- (default: ``False``); if it is set to ``True``,
767767
then it computes the BCH bound using the longest arithmetic sequence
768768
definition
769769

‎src/sage/combinat/combinatorial_map.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ def __get__(self, inst, cls=None):
286286

287287
def __call__(self, *args, **kwds):
288288
"""
289-
Calls the combinatorial map.
289+
Call the combinatorial map.
290290
291291
EXAMPLES::
292292

‎src/sage/combinat/matrices/dancing_links.pyx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -992,10 +992,10 @@ cdef class dancing_linksWrapper:
992992
993993
INPUT:
994994
995-
- ``solver`` -- string or ``None`` (default: ``None``), possible
995+
- ``solver`` -- string or ``None`` (default: ``None``); possible
996996
values include ``'GLPK'``, ``'GLPK/exact'``, ``'Coin'``,
997997
``'CPLEX'``, ``'Gurobi'``, ``'CVXOPT'``, ``'PPL'``,
998-
``'InteractiveLP'``.
998+
``'InteractiveLP'``
999999
10001000
OUTPUT:
10011001
@@ -1063,10 +1063,10 @@ cdef class dancing_linksWrapper:
10631063
10641064
INPUT:
10651065
1066-
- ``solver`` -- string or ``None`` (default: ``None``), possible
1066+
- ``solver`` -- string or ``None`` (default: ``None``); possible
10671067
values include ``'GLPK'``, ``'GLPK/exact'``, ``'Coin'``,
10681068
``'CPLEX'``, ``'Gurobi'``, ``'CVXOPT'``, ``'PPL'``,
1069-
``'InteractiveLP'``.
1069+
``'InteractiveLP'``
10701070
10711071
OUTPUT: list of rows or ``None`` if no solution is found
10721072

‎src/sage/combinat/posets/lattices.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1535,7 +1535,7 @@ def is_trim(self, certificate=False):
15351535
15361536
INPUT:
15371537
1538-
- ``certificate`` -- boolean (default: ``False``) whether to return
1538+
- ``certificate`` -- boolean (default: ``False``); whether to return
15391539
instead a maximum chain of left modular elements
15401540
15411541
EXAMPLES::

‎src/sage/combinat/posets/posets.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4366,7 +4366,7 @@ def coxeter_smith_form(self, algorithm='singular'):
43664366
43674367
INPUT:
43684368
4369-
- ``algorithm`` -- (default: ``'singular'``), possible
4369+
- ``algorithm`` -- (default: ``'singular'``); possible
43704370
values are ``'singular'``, ``'sage'``, ``'gap'``,
43714371
``'pari'``, ``'maple'``, ``'magma'``, ``'fricas'``
43724372

0 commit comments

Comments
 (0)