On Fri, 28 Aug 2015, Travis Scrimshaw wrote:
Tab completion and the ? (and ??) are your best friends and will do well to guide you.
To some degree, yes. But it contains some noise, like is_exact for Partitions.
3) And then it is still open if the index of functions can be written from user perspective, or from implementation perspective: http://trac.sagemath.org/ticket/18534 . My suggestion one is adding functions from categories to index of posets.py.
As for 3, what if you have class A with a subclass B in separate files (let's say, Parent and Partitions). Should you include all methods from class A in the doc of class B? If the answer is yes, then you must include all of the superclasses (and stop picking on the categories)
It is totally different thing if a subclass has mathematical meaning. User can be expected to know that a lattice is a poset. Knowing about categories needs information about Sage internals.
I do know that there are corner cases. A student learning group theory propably does not know that a group is a monoid and a semigroup and... (But learning that in a process of learning Sage is good thing, as it is mathematical information and useful more than in just one software.)
What would be the problem of having this kind of links if indexes?
2) There is a discussion about guide to writing docstrings: http://trac.sagemath.org/ticket/19041 .
Just pinging this one. This is more important than question three. -- Jori Mäntysalo
