Skip to content
This repository has been archived by the owner on Jan 30, 2023. It is now read-only.

Commit

Permalink
trac 34168: fix docstring markup for src/categories
Browse files Browse the repository at this point in the history
  • Loading branch information
jhpalmieri committed Jul 12, 2022
1 parent 625ac58 commit be5851f
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 13 deletions.
2 changes: 1 addition & 1 deletion src/sage/categories/affine_weyl_groups.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ class AffineWeylGroups(Category_singleton):
"""
The category of affine Weyl groups
.. todo:: add a description of this category
.. TODO:: add a description of this category
.. SEEALSO::
Expand Down
2 changes: 1 addition & 1 deletion src/sage/categories/category.py
Original file line number Diff line number Diff line change
Expand Up @@ -1392,7 +1392,7 @@ def _test_category_graph(self, **options):
method resolution order of the parent and element
classes. This method checks this.
.. todo:: currently, this won't work for hom categories.
.. TODO:: currently, this won't work for hom categories.
EXAMPLES::
Expand Down
6 changes: 4 additions & 2 deletions src/sage/categories/facade_sets.py
Original file line number Diff line number Diff line change
Expand Up @@ -186,8 +186,10 @@ def __contains__(self, element):
Returns whether ``element`` is in one of the parents
``self`` is a facade for.
.. warning:: this default implementation is currently
overridden by :meth:`Parent.__contains__`.
.. warning::
this default implementation is currently
overridden by :meth:`Parent.__contains__`.
EXAMPLES::
Expand Down
2 changes: 1 addition & 1 deletion src/sage/categories/fields.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def __contains__(self, x):
This implementation will not be needed anymore once every
field in Sage will be properly declared in the category
:class:`Fields`().
:class:`Fields`.
Caveat: this should eventually be fixed::
Expand Down
4 changes: 2 additions & 2 deletions src/sage/categories/finite_coxeter_groups.py
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ def bruhat_poset(self, facade=False):
sage: [len(WeylGroup(["A", n]).bruhat_poset().cover_relations()) for n in [1,2,3]]
[1, 8, 58]
.. todo::
.. TODO::
- Use the symmetric group in the examples (for nicer
output), and print the edges for a stronger test.
Expand Down Expand Up @@ -464,7 +464,7 @@ def weak_poset(self, side="right", facade=False):
sage: [len(WeylGroup(["A", n]).weak_poset(side = "left" ).cover_relations()) for n in [1,2,3]]
[1, 6, 36]
.. todo::
.. TODO::
- Use the symmetric group in the examples (for nicer
output), and print the edges for a stronger test.
Expand Down
2 changes: 1 addition & 1 deletion src/sage/categories/hecke_modules.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ def _Hom_(self, Y, category):
INPUT:
- ``Y`` -- an Hecke module
- ``category`` -- a subcategory of :class:`HeckeModules`() or None
- ``category`` -- a subcategory of :class:`HeckeModules` or None
The sole purpose of this method is to construct the homset
as a :class:`~sage.modular.hecke.homspace.HeckeModuleHomspace`. If
Expand Down
2 changes: 1 addition & 1 deletion src/sage/categories/integral_domains.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def __contains__(self, x):
This implementation will not be needed anymore once every
field in Sage will be properly declared in the category
:class:`IntegralDomains`().
:class:`IntegralDomains`.
"""
try:
return self._contains_helper(x) or x.is_integral_domain()
Expand Down
2 changes: 1 addition & 1 deletion src/sage/categories/rings.py
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ def _Hom_(self, Y, category):
INPUT:
- ``Y`` -- a ring
- ``category`` -- a subcategory of :class:`Rings`() or None
- ``category`` -- a subcategory of :class:`Rings` or None
The sole purpose of this method is to construct the homset
as a :class:`~sage.rings.homset.RingHomset`. If
Expand Down
6 changes: 3 additions & 3 deletions src/sage/categories/unique_factorization_domains.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ def __contains__(self, x):
This implementation will not be needed anymore once every
field in Sage will be properly declared in the category
:class:`UniqueFactorizationDomains`().
:class:`UniqueFactorizationDomains`.
"""
try:
return self._contains_helper(x) or x.is_unique_factorization_domain()
Expand Down Expand Up @@ -221,7 +221,7 @@ def radical(self, *args, **kwds):
This default implementation calls ``squarefree_decomposition`` if
available, and ``factor`` otherwise.
.. seealso:: :meth:`squarefree_part`
.. SEEALSO:: :meth:`squarefree_part`
EXAMPLES::
Expand Down Expand Up @@ -271,7 +271,7 @@ def squarefree_part(self):
This default implementation calls ``squarefree_decomposition``.
.. seealso:: :meth:`radical`
.. SEEALSO:: :meth:`radical`
EXAMPLES::
Expand Down

0 comments on commit be5851f

Please sign in to comment.