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

Commit 4958d6d

Browse files
author
Matthias Koeppe
committedSep 3, 2022
Modules.ParentMethods.quotient: Expand docstring
1 parent c446078 commit 4958d6d

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed
 

Diff for: ‎src/sage/categories/modules.py

+16-2
Original file line numberDiff line numberDiff line change
@@ -679,8 +679,6 @@ def quotient(self, submodule, check=True, **kwds):
679679
r"""
680680
Construct the quotient module ``self`` / ``submodule``.
681681
682-
This method just delegates to :meth:`quotient_module`.
683-
684682
INPUT:
685683
686684
- ``submodule`` -- a submodule with basis of ``self``, or
@@ -689,6 +687,22 @@ def quotient(self, submodule, check=True, **kwds):
689687
690688
- ``check``, other keyword arguments: passed on to
691689
:meth:`quotient_module`.
690+
691+
This method just delegates to :meth:`quotient_module`.
692+
Classes implementing modules should override that method.
693+
694+
Parents in categories with additional structure may override
695+
:meth:`quotient`. For example, in algebras, :meth:`quotient` will
696+
be the same as :meth:`quotient_ring`.
697+
698+
EXAMPLES::
699+
700+
sage: C = CombinatorialFreeModule(QQ, ['a','b','c'])
701+
sage: TA = TensorAlgebra(C)
702+
sage: TA.quotient
703+
<bound method Rings.ParentMethods.quotient of
704+
Tensor Algebra of Free module generated by {'a', 'b', 'c'} over Rational Field>
705+
692706
"""
693707
return self.quotient_module(submodule, check=check, **kwds)
694708

0 commit comments

Comments
 (0)
This repository has been archived.