Tab completion and the ? (and ??) are your best friends and will do well to guide you.
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), otherwise maybe (and I really do mean *maybe*) a link to the category(ies) is desirable. I would say if one wants a table of functions, it should be those defined in that particular file (because they will be in that particular page). Best, Travis On Friday, August 28, 2015 at 12:38:29 AM UTC-5, Jori Mäntysalo wrote: > > Those interested in documentation might want to look at few tickets. > > 1) Nathann is making an automatic index of functions better, see > http://trac.sagemath.org/ticket/19061 . (But somebody should review > #19067 > before that will continue. It is short.) > > 2) There is a discussion about guide to writing docstrings: > http://trac.sagemath.org/ticket/19041 . For example do we want to > *always* > have INPUT and OUTPUT section, even if the function returns nothing and > have no arguments? > > 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. Suggestion two is add an > index of functions ta categories of poset and finite poset and add a link > to them. Suggestion three is to make a kind of introduction to finite > posets and put index there. > > * * * > > 4) Do others feel that Sage is like a big house with tresures hidden in > the corridors - without map to found those? > > -- > Jori Mäntysalo > -- You received this message because you are subscribed to the Google Groups "sage-devel" 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-devel. For more options, visit https://groups.google.com/d/optout.
