Skip to content

Commit 554d014

Browse files
committed
Docstring edits
Work in `rings`.
1 parent d176a3e commit 554d014

100 files changed

Lines changed: 2042 additions & 2690 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_ring.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ class FusionRing(WeylCharacterRing):
4646
- ``fusion_labels`` -- (default: ``None``) either a tuple of strings to use as labels of the
4747
basis of simple objects, or a string from which the labels will be
4848
constructed
49-
- ``inject_variables`` -- (default: ``False``): use with ``fusion_labels``.
49+
- ``inject_variables`` -- (default: ``False``) use with ``fusion_labels``.
5050
If ``inject_variables`` is ``True``, the fusion labels will be variables
5151
that can be accessed from the command line
5252
@@ -387,7 +387,7 @@ def test_braid_representation(self, max_strands=6, anyon=None):
387387
388388
INPUT:
389389
390-
- ``max_strands`` -- (default: 6): maximum number of braid group strands
390+
- ``max_strands`` -- (default: 6) maximum number of braid group strands
391391
- ``anyon`` -- (optional) run this test on this particular simple object
392392
393393
Create a braid group representation using :meth:`get_braid_generators`

src/sage/combinat/diagram_algebras.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4727,7 +4727,7 @@ def TL_diagram_ascii_art(diagram, use_unicode=False, blobs=[]):
47274727
47284728
- ``diagram`` -- list of pairs of matchings of the set
47294729
`\{-1, \ldots, -n, 1, \ldots, n\}`
4730-
- ``use_unicode`` -- (default: ``False``): whether or not
4730+
- ``use_unicode`` -- boolean (default: ``False``); whether or not
47314731
to use unicode art instead of ascii art
47324732
- ``blobs`` -- (optional) a list of matchings with blobs on them
47334733

src/sage/combinat/tableau.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3719,7 +3719,7 @@ def left_key_tableau(self):
37193719
Return the left key tableau of ``self``.
37203720
37213721
The left key tableau of a tableau `T` is the key tableau whose entries
3722-
are weakly lesser than the corresponding entries in `T`, and whose column
3722+
are weakly less than the corresponding entries in `T`, and whose column
37233723
reading word is subject to certain conditions. See [LS1990]_ for the full definition.
37243724
37253725
ALGORITHM:

src/sage/geometry/hyperplane_arrangement/plot.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
(default: black)
1919
2020
- ``label_fontsize`` -- size for hyperplane_label font (default:
21-
``14``); This does not work for 3d plots
21+
``14``); this does not work for 3d plots
2222
2323
- ``label_offsets`` -- amount be which labels are offset from
2424
h.point() for each hyperplane h. The format is different for each

src/sage/geometry/lattice_polytope.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -716,7 +716,7 @@ def __reduce__(self):
716716

717717
def __setstate__(self, state):
718718
r"""
719-
Restores the state of pickled polytope.
719+
Restore the state of pickled polytope.
720720
721721
TESTS::
722722

src/sage/graphs/generic_graph.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22119,7 +22119,7 @@ def graphviz_string(self, **options):
2211922119
dictionary of options for this edge
2212022120

2212122121
- ``rankdir`` -- ``'left'``, ``'right'``, ``'up'``, or ``'down'``
22122-
(default: ``'down'``, for consistency with ``graphviz``): the
22122+
(default: ``'down'``, for consistency with ``graphviz``); the
2212322123
preferred ranking direction for acyclic layouts; see the ``rankdir``
2212422124
option of ``graphviz``.
2212522125

src/sage/lfunctions/zero_sums.pyx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -778,7 +778,7 @@ cdef class LFunctionZeroSum_abstract(SageObject):
778778
779779
INPUT:
780780
781-
- ``Delta`` -- positive real number (default: 1) parameter denoting the
781+
- ``Delta`` -- positive real number (default: 1); parameter denoting the
782782
tightness of the zero sum
783783
784784
- ``tau`` -- real parameter (default: 0) denoting the offset of the sum
@@ -788,7 +788,7 @@ cdef class LFunctionZeroSum_abstract(SageObject):
788788
be 1 (assuming GRH, the zero is simple); otherwise the limit will
789789
be 0.
790790
791-
- ``num_terms`` -- positive integer (default: ``None``): the number of
791+
- ``num_terms`` -- positive integer (default: ``None``); the number of
792792
terms computed in the truncated Dirichlet series for the L-function
793793
attached to ``self``. If left at ``None``, this is set to
794794
`\ceil(e^{2 \pi \Delta})`, the same number of terms used in the other

src/sage/matrix/matrix2.pyx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5621,9 +5621,9 @@ cdef class Matrix(Matrix1):
56215621

56225622
- ``self`` -- a matrix
56235623

5624-
- ``algorithm`` -- 'spin' (default): algorithm involves
5625-
iterating the action of ``self`` on a vector. 'kernel': naively just
5626-
compute `ker(f_i(A))` for each factor `f_i`.
5624+
- ``algorithm`` -- string (default: ``'spin'``); ``'spin'``: involves
5625+
iterating the action of ``self`` on a vector. ``'kernel'``: naively
5626+
just compute `ker(f_i(A))` for each factor `f_i`.
56275627

56285628
- ``dual`` -- boolean (default: ``False``); if True, also
56295629
returns the corresponding decomposition of V under the action of

src/sage/matrix/matrix_integer_dense.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3977,7 +3977,7 @@ cdef class Matrix_integer_dense(Matrix_dense):
39773977
39783978
- ``self`` -- an invertible matrix
39793979
3980-
- ``use_nullspace`` -- (default: ``False``): whether to
3980+
- ``use_nullspace`` -- boolean (default: ``False``); whether to
39813981
use nullspace algorithm, which is slower, but doesn't require
39823982
checking that the matrix is invertible as a precondition
39833983

src/sage/modular/modform/element.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1180,7 +1180,7 @@ def petersson_norm(self, embedding=0, prec=53):
11801180
- ``embedding`` -- embedding of the coefficient field into `\RR` or
11811181
`\CC`, or an integer `i` (interpreted as the `i`-th embedding)
11821182
(default: 0)
1183-
- ``prec`` -- integer (default: 53): precision in bits
1183+
- ``prec`` -- integer (default: 53); precision in bits
11841184
11851185
EXAMPLES::
11861186

0 commit comments

Comments
 (0)