TensorFreeModule.basis: Add documentation

sagemath · Aug 26, 2022 · d1376fd · d1376fd
1 parent 30d4eec
commit d1376fd
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/src/sage/tensor/modules/tensor_free_module.py b/src/sage/tensor/modules/tensor_free_module.py
@@ -715,6 +715,17 @@ def basis(self, symbol, latex_symbol=None, from_family=None,
         r"""
         Return the standard basis of ``self`` corresponding to a basis of the base module.
 
+        INPUT:
+
+        - ``symbol``, ``indices`` -- passed to he base module's method
+          :meth:`~sage.tensor.modules.finite_rank_free_module.FiniteRankFreeModule.basis`
+          to select a basis of the :meth:`base_module` of ``self``,
+          or to create it.
+
+        - other parameters -- passed to
+          :meth:`~sage.tensor.modules.finite_rank_free_module.FiniteRankFreeModule.basis`; when
+          the basis does not exist yet, it will be created using these parameters.
+
         EXAMPLES::
 
             sage: M = FiniteRankFreeModule(ZZ, 3, name='M')