Skip to content

Commit 07dd3f3

Browse files
gmou3gmou3
committed
Docstring suggestions by kwankyu
For commits 6b3aeff and 6d8aa62.
1 parent 7abd33c commit 07dd3f3

37 files changed

Lines changed: 113 additions & 116 deletions

‎src/sage/algebras/lie_conformal_algebras/bosonic_ghosts_lie_conformal_algebra.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ class BosonicGhostsLieConformalAlgebra(GradedLieConformalAlgebra):
4747
algebra.
4848
- ``names`` -- list of ``str``; alternative names for the
4949
generators
50-
- ``index_set`` -- an enumerated set; An indexing set for the
50+
- ``index_set`` -- an enumerated set; an indexing set for the
5151
generators
5252
5353
OUTPUT:

‎src/sage/categories/finite_posets.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1676,19 +1676,19 @@ def rowmotion_orbit_iter(self, oideal, element_constructor=set, stop=True, check
16761676
- ``oideal`` -- an order ideal of ``self``, given as an
16771677
iterable
16781678
1679-
- ``element_constructor`` (defaults to ``set``) -- a type
1679+
- ``element_constructor`` -- (defaults to ``set``) a type
16801680
constructor (``set``, ``tuple``, ``list``, ``frozenset``,
16811681
``iter``, etc.) which is to be applied to the order
1682-
ideals before they are yielded.
1682+
ideals before they are yielded
16831683
16841684
- ``stop`` -- boolean (default: ``True``);
16851685
whether the iterator should stop once it completes its
16861686
cycle (this happens when it is set to ``True``) or go on
1687-
forever (this happens when it is set to ``False``).
1687+
forever (this happens when it is set to ``False``)
16881688
16891689
- ``check`` -- boolean (default: ``True``);
16901690
whether ``oideal`` should be checked for being an
1691-
order ideal.
1691+
order ideal
16921692
16931693
OUTPUT:
16941694
@@ -1785,7 +1785,7 @@ def toggling_orbit_iter(self, vs, oideal, element_constructor=set, stop=True, ch
17851785
- ``oideal`` -- an order ideal of ``self``, given as an
17861786
iterable
17871787
1788-
- ``element_constructor`` (defaults to ``set``) -- a type
1788+
- ``element_constructor`` -- (default: ``set``) a type
17891789
constructor (``set``, ``tuple``, ``list``, ``frozenset``,
17901790
``iter``, etc.) which is to be applied to the order
17911791
ideals before they are yielded.

‎src/sage/categories/magmas.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -861,7 +861,7 @@ def multiplication_table(self, names='letters', elements=None):
861861
of the elements themselves.
862862
* a list - a list of strings, where the length
863863
of the list equals the number of elements.
864-
- ``elements`` -- default = ``None``. A list of
864+
- ``elements`` -- (default: ``None``) a list of
865865
elements of the magma, in forms that can be
866866
coerced into the structure, eg. their string
867867
representations. This may be used to impose an

‎src/sage/combinat/designs/subhypergraph_search.pyx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,20 +31,20 @@ over `|V(H_1)|` points. In particular, two sets of distinct cardinalities
3131
require the same memory space. A hypergraph is a C struct with the following
3232
fields:
3333
34-
* ``n,m`` (``int``) -- number of points and edges.
34+
* ``n``, ``m`` -- (``int``) number of points and edges
3535
36-
* ``limbs`` (``int``) -- number of 64-bits blocks per set.
36+
* ``limbs`` -- (``int``) number of 64-bits blocks per set
3737
38-
* ``set_space`` (``uint64_t *``) -- address of the memory used to store the
39-
sets.
38+
* ``set_space`` -- (``uint64_t *``) address of the memory used to store the
39+
sets
4040
41-
* ``sets`` (``uint64_t **``) -- ``sets[i]`` points toward the ``limbs``
41+
* ``sets`` -- (``uint64_t **``) ``sets[i]`` points toward the ``limbs``
4242
blocks encoding set `i`. Note also that ``sets[i][limbs]`` is equal to the
4343
cardinality of ``set[i]``, so that ``sets`` has length
4444
``m*(limbs+1)*sizeof(uint64_t)``.
4545
46-
* ``names`` (``int *``) -- associates an integer 'name' to each of the ``n``
47-
points.
46+
* ``names`` -- (``int *``) associates an integer 'name' to each of the ``n``
47+
points
4848
4949
The operations used on this data structure are:
5050

‎src/sage/combinat/finite_state_machine_generators.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -628,7 +628,7 @@ def operator(self, operator, input_alphabet, number_of_operands=2):
628628
EXAMPLES:
629629
630630
The following binary transducer realizes component-wise
631-
addition (this transducer is also available as :meth:`.add`)::
631+
addition (this transducer is also available as :meth:`add`)::
632632
633633
sage: import operator
634634
sage: T = transducers.operator(operator.add, [0, 1])

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3696,7 +3696,7 @@ def is_dismantlable(self, certificate=False):
36963696
36973697
INPUT:
36983698
3699-
- ``certificate`` -- boolean; Whether to return a certificate
3699+
- ``certificate`` -- boolean; whether to return a certificate
37003700
37013701
* If ``certificate = False`` (default), returns ``True`` or
37023702
``False`` accordingly.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@
8484
:meth:`~FinitePoset.is_incomparable_chain_free` | Return ``True`` if the poset is (m+n)-free.
8585
:meth:`~FinitePoset.is_slender` | Return ``True`` if the poset is slender.
8686
:meth:`~FinitePoset.is_sperner` | Return ``True`` if the poset is Sperner.
87-
:meth:`~FinitePoset.is_join_semilattice` | Return ``True`` is the poset has a join operation.
87+
:meth:`~FinitePoset.is_join_semilattice` | Return ``True`` if the poset has a join operation.
8888
:meth:`~FinitePoset.is_meet_semilattice` | Return ``True`` if the poset has a meet operation.
8989
9090
**Minimal and maximal elements**

‎src/sage/geometry/lattice_polytope.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4487,7 +4487,7 @@ def Delta(self, i=None):
44874487
44884488
INPUT:
44894489
4490-
- ``i`` -- integer; If not given, `\Delta` will be returned
4490+
- ``i`` -- integer; if not given, `\Delta` will be returned
44914491
44924492
OUTPUT: a :class:`lattice polytope <LatticePolytopeClass>`
44934493

‎src/sage/geometry/polyhedron/base_ZZ.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -338,7 +338,7 @@ def ehrhart_polynomial(self, engine=None, variable='t', verbose=False, dual=None
338338
space
339339
* ``irrational_primal`` -- boolean; triangulate in the dual space,
340340
signed-decompose in the primal space using irrationalization.
341-
* ``irrational_all_primal`` -- boolean; Triangulate and signed-decompose
341+
* ``irrational_all_primal`` -- boolean; triangulate and signed-decompose
342342
in the primal space using irrationalization.
343343
* ``maxdet`` -- integer; decompose down to an index (determinant) of
344344
``maxdet`` instead of index 1 (unimodular cones).

‎src/sage/geometry/toric_lattice.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1659,7 +1659,7 @@ def is_torsion_free(self):
16591659
r"""
16601660
Check if ``self`` is torsion-free.
16611661
1662-
OUTPUT: ``True`` is ``self`` has no torsion and ``False`` otherwise
1662+
OUTPUT: ``True`` if ``self`` has no torsion and ``False`` otherwise
16631663
16641664
EXAMPLES::
16651665

0 commit comments

Comments
 (0)