Comment #8 on issue 2774 by tlora...@gmail.com: ``See Also`` feature in
Number Theory
http://code.google.com/p/sympy/issues/detail?id=2774
Actually the format for classes is the same as for functions - you don't
have to add class:`...` for classes. So the See Also section should look
like this:
See Also
========
funcname1 : description
classname1 : description
classname2, classname3, funcname2
And regarding descriptions - i think that it is not always better to
include a description. Most functions in SymPy have names transparent
enough to deduce the functionality from the name. Sure, you could add some
extra information about function in the description, but that belongs to
function's docstring (before using the function you will anyway have to
look at its docstring). For example, functions like prime, isprime,
nextprime, prevprime, primerange don't need a description, while primepi
might use one.
When we come to an agreement about the use of descriptions, we should write
down the rules here:
https://github.com/sympy/sympy/wiki/Writing-documentation
--
You received this message because you are subscribed to the Google Groups
"sympy-issues" group.
To post to this group, send email to sympy-issues@googlegroups.com.
To unsubscribe from this group, send email to
sympy-issues+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sympy-issues?hl=en.
