Skip to content

Commit 402bec3

Browse files
committed
fix a bunch of similar errors in the doc
1 parent 5b78749 commit 402bec3

File tree

10 files changed

+20
-16
lines changed

10 files changed

+20
-16
lines changed

src/sage/categories/additive_magmas.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -730,7 +730,7 @@ def is_empty(self):
730730
731731
TESTS:
732732
733-
We check that the method `is_empty` is inherited from this
733+
We check that the method ``is_empty`` is inherited from this
734734
category in both examples above::
735735
736736
sage: A.is_empty.__module__

src/sage/categories/category.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2236,7 +2236,7 @@ def _sort(categories):
22362236
22372237
.. NOTE::
22382238
2239-
The auxiliary function `_flatten_categories` used in the test
2239+
The auxiliary function ``_flatten_categories`` used in the test
22402240
below expects a second argument, which is a type such that
22412241
instances of that type will be replaced by its super
22422242
categories. Usually, this type is :class:`JoinCategory`.

src/sage/categories/coxeter_groups.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -668,7 +668,7 @@ def _test_reduced_word(self, **options):
668668

669669
def simple_projection(self, i, side='right', length_increasing=True):
670670
r"""
671-
Return the simple projection `\pi_i` (or `\overline\pi_i` if `length_increasing` is ``False``).
671+
Return the simple projection `\pi_i` (or `\overline\pi_i` if ``length_increasing`` is ``False``).
672672
673673
INPUT:
674674

src/sage/categories/crystals.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1563,7 +1563,9 @@ def to_highest_weight(self, index_set=None):
15631563
r"""
15641564
Return the highest weight element `u` and a list `[i_1,...,i_k]`
15651565
such that `self = f_{i_1} ... f_{i_k} u`, where `i_1,...,i_k` are
1566-
elements in `index_set`. By default the index set is assumed to be
1566+
elements in ``index_set``.
1567+
1568+
By default the index set is assumed to be
15671569
the full index set of self.
15681570
15691571
EXAMPLES::
@@ -1602,8 +1604,10 @@ def to_lowest_weight(self, index_set=None):
16021604
r"""
16031605
Return the lowest weight element `u` and a list `[i_1,...,i_k]`
16041606
such that `self = e_{i_1} ... e_{i_k} u`, where `i_1,...,i_k` are
1605-
elements in `index_set`. By default the index set is assumed to be
1606-
the full index set of self.
1607+
elements in ``index_set``.
1608+
1609+
By default the index set is assumed to be the full index
1610+
set of self.
16071611
16081612
EXAMPLES::
16091613
@@ -1642,7 +1646,7 @@ def to_lowest_weight(self, index_set=None):
16421646
def all_paths_to_highest_weight(self, index_set=None):
16431647
r"""
16441648
Iterate over all paths to the highest weight from ``self``
1645-
with respect to `index_set`.
1649+
with respect to ``index_set``.
16461650
16471651
INPUT:
16481652

src/sage/coding/cyclic_code.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ def __init__(self, generator_pol=None, length=None, code=None, check=True,
334334
...
335335
ValueError: The code is not cyclic.
336336
337-
If the `primitive_root` does not lie in an extension of `field`,
337+
If the ``primitive_root`̀ does not lie in an extension of ``field``,
338338
or is not a primitive `n`-th root of unity, then
339339
an exception is raised::
340340

src/sage/crypto/block_cipher/present.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -838,7 +838,7 @@ def __getitem__(self, r):
838838
Computes the sub key for round ``r`` derived from initial master key.
839839
840840
The key schedule object has to have been initialised with the
841-
`master_key` argument.
841+
``master_key`` argument.
842842
843843
INPUT:
844844
@@ -860,7 +860,7 @@ def __getitem__(self, r):
860860
def __iter__(self):
861861
"""
862862
Iterate over the ``self._rounds + 1`` PRESENT round keys, derived from
863-
`master_key`
863+
``master_key``.
864864
865865
EXAMPLES::
866866

src/sage/dynamics/finite_dynamical_system_catalog.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
dynamical systems.
66
These are accessible through
77
:mod:`sage.dynamics.finite_dynamical_system_catalog. <sage.dynamics.finite_dynamical_system_catalog>`
8-
or just through `finite_dynamical_systems.`
8+
or just through ``finite_dynamical_systems.``
99
(type either of these in Sage and hit ``tab`` for a list).
1010
1111
AUTHORS:

src/sage/graphs/weakly_chordal.pyx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ cdef inline is_long_hole_free_process(g, short_digraph sd, bitset_t dense_graph,
5353
bint certificate,
5454
int a, int b, int c, int n):
5555
"""
56-
This method is part of method `is_long_hole_free`.
56+
This method is part of method ``is_long_hole_free``.
5757
5858
EXAMPLES::
5959
@@ -285,7 +285,7 @@ cdef inline is_long_antihole_free_process(g, short_digraph sd, bitset_t dense_gr
285285
bint certificate,
286286
int a, int b, int c, int n):
287287
"""
288-
This method is part of method `is_long_antihole_free`.
288+
This method is part of method ``is_long_antihole_free``.
289289
290290
EXAMPLES::
291291

src/sage/matrix/matrix_misc.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ def prm_mul(p1, p2, mask_free, prec):
3939
4040
- `p1,p2` -- polynomials as dictionaries
4141
42-
- `mask_free` -- an integer mask that give the list of free variables
42+
- ``mask_free`` -- an integer mask that give the list of free variables
4343
(the `i`-th variable is free if the `i`-th bit of ``mask_free`` is `1`)
4444
45-
- `prec` -- if `prec` is not None, truncate the product at precision `prec`
45+
- ``prec`` -- if ``prec`` is not ``None``, truncate the product at precision ``prec``
4646
4747
EXAMPLES::
4848

src/sage/symbolic/function.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -502,7 +502,7 @@ cdef class Function(SageObject):
502502
sage: (out, parent(out))
503503
(0, Integer Ring)
504504
505-
Check that `real_part` and `imag_part` still works after :trac:`21216`::
505+
Check that ``real_part`` and ``imag_part`` still works after :trac:`21216`::
506506
507507
sage: import numpy
508508
sage: a = numpy.array([1+2*I, -2-3*I], dtype=complex)

0 commit comments

Comments
 (0)