Dear Fan,
I definitely agree that browsing through the reference manual is a pain.
For general reference, I would advise to use one of the introductory
books that are better organized
- http://sagebook.gforge.inria.fr/english.html
- http://www.people.vcu.edu/~clarson/bard-sage-for-undergraduates-2014.pdf
The reference manual is compiled from the source code. It is efficient
if you want to know which option accept a given function. And the most
useful way to browse it is directly in the console (with one question
mark '?' and then enter)
sage: Mod?
Docstring:
Return the equivalence class of n modulo m as an element of
ZZ/mZZ.
[...]
Python/Sage offers some convenient introspection that allows you
to obtain the source code (two question marks '??')
sage: Mod??
[...]
File:
/usr/lib/python2.7/site-packages/sage/rings/finite_rings/integer_mod.pyx
I copied only the last line because it mentions the file where
this function is implemented.
Vincent
Le 07/04/2019 à 22:55, Fan Zhang a écrit :
Hi all, I'm a new user to Sage and could your help in getting my speed up.
Sage itself is quite user-friendly but my main challenge has been
navigating through the doc. I've been using the [official
reference](http://doc.sagemath.org/html/en/reference) to look up function
definitions etc. However I find the experience suboptimal. For example, I
couldn't figure out the difference between `Mod`, `Integers`,
`IntegersModRing` after quite some effort. (Despite they're frequently used
in the [example code
](http://doc.sagemath.org/html/en/reference/finite_rings/sage/rings/finite_rings/integer_mod.html)).
Moreover, I can't even find where `Mod` is defined.
More generally, what's the preferred way to browse the documentation? The
search function works but it returns an awful lot from which it is hard to
pick out the useful piece...
--
You received this message because you are subscribed to the Google Groups
"sage-support" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to sage-support+unsubscr...@googlegroups.com.
To post to this group, send email to sage-support@googlegroups.com.
Visit this group at https://groups.google.com/group/sage-support.
For more options, visit https://groups.google.com/d/optout.
