Hi David, On Thu, Oct 7, 2010 at 1:10 AM, David Joyner <[email protected]> wrote: > This is a really excellent response! > > Do you think it should be added to the FAQ on the wiki ("I wanted to find > the code for a function using > sage: foo?? > but couldn't. What is going on here?"),
This issue is tracked at ticket #10091 [1]. Note that the Sage standard documentation ships an FAQ [2], in writing which I borrowed materials from the FAQ on the Sage wiki [3] as well as the Django FAQ [4]. The FAQ [2] as distributed with Sage and available on the Sage website has more materials than the FAQ on the Sage wiki. It can take some effort to maintain both FAQs, but I think that an FAQ should be shipped with any Sage source or binary distribution, hence my preference for the FAQ at [2]. However, this doesn't mean we should abandon the FAQ at on the Sage wiki. On the contrary, I think that the wiki can serve as a sandbox or sketch pad for developing new documentation materials. Once the documentation is matured enough, we could move it over to the Sage standard documentation. > or is it too technical? The question of getting the source code of a function, module, etc. comes up very frequently and it's a very important question that should be addressed in the Sage FAQ. The operator "?" to get documentation on a function, and the double question marks operator "??" to get documentation and source code, are two very important and immensely useful features that help to answer a lot of beginner's questions. The AskSage forum [5] also contains a lot of useful documentation that can be used to update the Sage FAQ, or serve as fodder for a Sage cookbook. [1] http://trac.sagemath.org/sage_trac/ticket/10091 [2] http://www.sagemath.org/doc/faq/ [3] http://wiki.sagemath.org/faq [4] http://docs.djangoproject.com/en/1.2/faq/ [5] http://ask.sagemath.org/question/18/what-are-the-10-most-often-used-functions-in-sage -- Regards Minh Van Nguyen -- To post to this group, send an email to [email protected] To unsubscribe from this group, send an email to [email protected] For more options, visit this group at http://groups.google.com/group/sage-devel URL: http://www.sagemath.org
