#15916: Tensors on free modules of finite rank
-------------------------------------+-------------------------------------
Reporter: egourgoulhon | Owner:
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-6.4
Component: linear algebra | Resolution:
Keywords: free module, | Merged in:
tensor, tensor product | Reviewers:
Authors: Eric Gourgoulhon, | Work issues:
Michal Bejger | Commit:
Report Upstream: N/A | d8f518ff48c8be2ea73f2b51e067af9e6c87b4bf
Branch: | Stopgaps:
u/egourgoulhon/tensor_modules |
Dependencies: |
-------------------------------------+-------------------------------------
Comment (by vbraun):
The `__init__` docstring is used as the class docstring if you don't
define a separate class docstring, and I would recommend using that.
You can document other underscore methods by adding, say,
{{{
.. automethod:: __mul__
}}}
at the end of the class docstring (possibly derived from the `__init__`
docstring as above).
Not all underscore methods need to appear in the reference manual, though.
The doctests are still tests, even if they are not end-user visible
"documentation". And they are documentation for developers reading the
source and wondering how to use that method...
--
Ticket URL: <http://trac.sagemath.org/ticket/15916#comment:22>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
