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

Commit

Permalink
Update input documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
trevorkarn committed Jul 9, 2021
1 parent 553dc56 commit 2a64c19
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions src/sage/modules/with_basis/invariant.py
Expand Up @@ -4,6 +4,7 @@

# ****************************************************************************
# Copyright (C) 2021 Trevor K. Karn <karnx018 at umn.edu>
# Travis Scrimshaw
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
Expand Down Expand Up @@ -32,8 +33,15 @@ class FiniteDimensionalInvariantModule(SubmoduleWithBasis):
INPUT:
- ``R`` -- an instance of a ``Representation`` of a semigroup `S`
acting on the module `M`
- ``M`` - a module in the category of
:class:`~sage.categories.finite_dimensional_modules_with_basis.FiniteDimensionalModulesWithBasis`
- ``S`` - a semigroup in the category of
:class:`~sage.categories.finitely_generated_semigroups.FinitelyGeneratedSemigroups`
- ``action`` - (default: ``operator.mul``) the action of ``S`` on ``M``.
- ``side`` - (default: ``'left'``) the side on which ``S`` acts.
EXAMPLES:
Expand Down Expand Up @@ -296,7 +304,7 @@ def _latex_(self):
from sage.misc.latex import latex
return "\\left( {} \\right)^{{{}}}".format(latex(M), latex(self._semigroup))

def _test_invariant(self, **options): ## Lift to representation and check that the element is invariant
def _test_invariant(self, **options):
"""
Check (on some elements) that ``self`` is invariant.
Expand Down

0 comments on commit 2a64c19

Please sign in to comment.