Skip to content

Commit 6d8aa62

Browse files
gmou3gmou3
committed
Docstring edits
Work in `numerical`.
1 parent 6b3aeff commit 6d8aa62

113 files changed

Lines changed: 1613 additions & 1895 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/fusion_rings/fusion_double.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -691,7 +691,8 @@ def product_on_basis(self, a, b):
691691
692692
INPUT:
693693
694-
- ``a`, ``b`` -- keys for the dictionary ``self._names`` representing simple objects
694+
- ``a``, ``b`` -- keys for the dictionary ``self._names`` representing
695+
simple objects
695696
696697
EXAMPLES::
697698

‎src/sage/algebras/fusion_rings/fusion_ring.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -773,7 +773,7 @@ def N_ijk(self, elt_i, elt_j, elt_k):
773773
774774
This is the same as `N_{ij}^{k\ast}`, where `N_{ij}^k` are
775775
the structure coefficients of the ring (see :meth:`Nk_ij`),
776-
and `k\ast`` denotes the dual element. The coefficient `N_{ijk}`
776+
and `k\ast` denotes the dual element. The coefficient `N_{ijk}`
777777
is unchanged under permutations of the three basis vectors.
778778
779779
EXAMPLES::

‎src/sage/algebras/fusion_rings/shm_managers.pyx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ cdef class KSHandler:
177177

178178
cpdef update(self, list eqns):
179179
r"""
180-
Update ```self``'s ``shared_memory``-backed dictionary of known
180+
Update ``self``'s ``shared_memory``-backed dictionary of known
181181
squares. Keys are variable indices and corresponding values
182182
are the squares.
183183

‎src/sage/algebras/iwahori_hecke_algebra.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -717,7 +717,7 @@ def __getitem__(self, i):
717717
718718
.. WARNING::
719719
720-
If `i`` is not a reduced expression then the basis element
720+
If ``i`` is not a reduced expression then the basis element
721721
indexed by the corresponding element of the algebra is
722722
returned rather than the corresponding product of the
723723
generators::

‎src/sage/categories/coxeter_groups.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2366,10 +2366,10 @@ def binary_factorizations(self, predicate=ConstantFunction(True)):
23662366
Iterating through this set is Constant Amortized Time
23672367
(counting arithmetic operations in the Coxeter group as
23682368
constant time) complexity, and memory linear in the length
2369-
of `self`.
2369+
of ``self``.
23702370
23712371
One can pass as optional argument a predicate p such that
2372-
`p(u)` implies `p(u')` for any `u` left factor of `self`
2372+
`p(u)` implies `p(u')` for any `u` left factor of ``self``
23732373
and `u'` left factor of `u`. Then this returns only the
23742374
factorizations `self = uv` such `p(u)` holds.
23752375

‎src/sage/categories/drinfeld_modules.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ class DrinfeldModules(Category_over_base_ring):
205205

206206
def __init__(self, base_field, name='t'):
207207
r"""
208-
Initialize `self`.
208+
Initialize ``self``.
209209
210210
INPUT:
211211

‎src/sage/categories/enumerated_sets.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -751,7 +751,7 @@ def _rank_from_iterator(self, x):
751751
``self.rank(x)`` returns the rank of `x`, that is its
752752
position in the enumeration of ``self``. This is an
753753
integer between ``0`` and ``n-1`` where ``n`` is the
754-
cardinality of ``self``, or None if `x` is not in `self`.
754+
cardinality of ``self``, or None if `x` is not in ``self``.
755755
756756
This is the default (brute force) implementation from the
757757
category ``EnumeratedSets()`` which can be used when the

‎src/sage/categories/facade_sets.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ def _element_constructor_(self, element):
5353
- ``element`` -- any object
5454
5555
This default implementation returns ``element`` if
56-
``self`` is a facade for ``parent(element)`. Otherwise it
56+
``self`` is a facade for ``parent(element)``. Otherwise it
5757
attempts in turn to coerce ``element`` into each parent
5858
``self`` is a facade for.
5959

‎src/sage/categories/magmas.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -380,7 +380,7 @@ def is_field(self, proof=True):
380380
Return ``True`` if ``self`` is a field.
381381
382382
For a magma algebra `RS` this is always false unless
383-
`S` is trivial and the base ring `R`` is a field.
383+
`S` is trivial and the base ring `R` is a field.
384384
385385
EXAMPLES::
386386

‎src/sage/categories/poor_man_map.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ def __mul__(self, other):
183183
- ``self`` -- a map `f`
184184
- ``other`` -- a map `g`
185185
186-
Returns the composition map `f\circ g` of `f`` and `g`
186+
Returns the composition map `f\circ g` of `f` and `g`
187187
188188
EXAMPLES::
189189

0 commit comments

Comments
 (0)