Skip to content

Commit

Permalink
Trac #34172: Fix docstring markup in sage/groups and sage/misc
Browse files Browse the repository at this point in the history
Part of #34157:
{{{
sage/groups/cubic_braid.py:1379:1: RST301 Unexpected indentation.
sage/groups/cubic_braid.py:1381:1: RST201 Block quote ends without a
blank line; unexpected unindent.
sage/misc/sagedoc.py:594:1: RST214 Inline literal start-string without
end-string.
sage/misc/sagedoc.py:670:1: RST214 Inline literal start-string without
end-string.
sage/misc/profiler.py:63:1: RST303 Unknown directive type "todo".
sage/misc/sage_input.py:1840:1: RST215 Inline interpreted text or phrase
reference start-string without end-string.
sage/misc/sage_input.py:1843:1: RST215 Inline interpreted text or phrase
reference start-string without end-string.
sage/misc/sage_input.py:2139:1: RST215 Inline interpreted text or phrase
reference start-string without end-string.
sage/misc/sage_input.py:2248:1: RST215 Inline interpreted text or phrase
reference start-string without end-string.
sage/misc/call.py:112:1: RST205 Explicit markup ends without a blank
line; unexpected unindent.
}}}

URL: https://trac.sagemath.org/34172
Reported by: klee
Ticket author(s): John Palmieri
Reviewer(s): Matthias Koeppe
  • Loading branch information
Release Manager committed Jul 25, 2022
2 parents 4142099 + 5da5e1f commit aa8a464
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 17 deletions.
10 changes: 5 additions & 5 deletions src/sage/groups/cubic_braid.py
Original file line number Diff line number Diff line change
Expand Up @@ -1373,13 +1373,13 @@ def _element_constructor_(self, x, **kwds):
INPUT:
- ``x`` -- can be one of the following:
-- an instance of the element class of ``self`` (but possible to a different parent).
-- an instance of the element class of the braid group.
-- a tuple representing a braid in Tietze form.
-- an instance of an element class of a parent P such that there is a map from ``self`` to P
- an instance of the element class of ``self`` (but possible to a different parent).
- an instance of the element class of the braid group.
- a tuple representing a braid in Tietze form.
- an instance of an element class of a parent P such that there is a map from ``self`` to P
having :meth:`lift`, for example an element of an alternative realization of ``self``, such
as the classical realization.
-- any other object which works for the element constructor of :class:`FinitelyPresentedGroup`.
- any other object which works for the element constructor of :class:`FinitelyPresentedGroup`.
OUTPUT:
Expand Down
10 changes: 6 additions & 4 deletions src/sage/misc/call.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,12 @@ def __hash__(self):
This method tries to ensure that, when two ``attrcall``
objects are equal, they have the same hash value.
.. warning:: dicts are not hashable, so we instead hash their
items; however the order of those items might differ. The
proper fix would be to use a frozen dict for ``kwds``, when
frozen dicts will be available in Python.
.. warning::
dicts are not hashable, so we instead hash their
items; however the order of those items might differ. The
proper fix would be to use a frozen dict for ``kwds``, when
frozen dicts will be available in Python.
EXAMPLES::
Expand Down
2 changes: 1 addition & 1 deletion src/sage/misc/profiler.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ class Profiler:
.. SEEALSO:: :func:`runsnake`
.. todo::
.. TODO::
- Add Pyrex source code inspection (I assume it doesn't
currently do this)
Expand Down
14 changes: 7 additions & 7 deletions src/sage/misc/sage_input.py
Original file line number Diff line number Diff line change
Expand Up @@ -1838,11 +1838,11 @@ def __init__(self, sib, func, args, kwargs):
- ``func`` - a :class:`SageInputExpression` representing a function
- ``args`` - a list of :class:`SageInputExpression`s representing the
positional arguments
- ``args`` - a list of instances of :class:`SageInputExpression`
representing the positional arguments
- ``kwargs`` -- a dictionary mapping strings to
:class:`SageInputExpression`s representing the keyword arguments
- ``kwargs`` -- a dictionary mapping strings to instances of
:class:`SageInputExpression` representing the keyword arguments
EXAMPLES::
Expand Down Expand Up @@ -2137,8 +2137,8 @@ def __init__(self, sib, values, is_list):
- ``sib`` -- a :class:`SageInputBuilder`
- ``values`` -- a list of :class:`SageInputExpression`s representing the
elements of this tuple
- ``values`` -- a list of instances of :class:`SageInputExpression`
representing the elements of this tuple
- ``is_list`` -- is True if this class represents a list, False for a
tuple
Expand Down Expand Up @@ -2246,7 +2246,7 @@ def __init__(self, sib, entries):
- ``sib`` -- a :class:`SageInputBuilder`
- ``entries`` -- a list of pairs of :class:`SageInputExpression`s
- ``entries`` -- a list of pairs of :class:`SageInputExpression`
representing the entries of this dict
EXAMPLES::
Expand Down
2 changes: 2 additions & 0 deletions src/tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,8 @@ rst-directives =
extend-ignore =
# Ignore RST306 Unknown target name -- because of references to the global bibliography
RST306
exclude =
sage/misc/sagedoc.py
[pytest]
python_files = *_test.py
Expand Down

0 comments on commit aa8a464

Please sign in to comment.