sagemath / sage

Main repository of SageMath. Now open for Issues and Pull Requests.
https://www.sagemath.org
Other
1.09k stars 394 forks source link

new section for tutorial about functions vs. expressions, etc. #5463

Closed jhpalmieri closed 15 years ago

jhpalmieri commented 15 years ago

There are lots of questions sage-support in which people trying to do basic calculus or plotting have gotten confused about how to specify a "function" to be plotted, differentiated, etc. The attached patch adds a section to the tutorial with some remarks about this issue.

See http://www.math.washington.edu/~palmieri/tutorial/tour_functions.html for a typeset version (although you can just type 'sage -docbuild tutorial html' to get your own version).

Component: documentation

Issue created by migration from https://trac.sagemath.org/ticket/5463

williamstein commented 15 years ago
comment:1

Looks good to me. Well I sort of don't like the **'s instead of ^'s, but that's just a very minor style issue. All of the actual text looks good, and I like the description.

The ReST here looks funny: http://www.math.washington.edu/~palmieri/tutorial/tour_functions.html

I.e., in each of the code blocks there is some text afterwards explaining the example, and it is typeset as code instead of text. I don't know why. Again, just a minor ReST issue. Mhansen?

85eec1a4-3d04-4b4d-b711-d4db03337c41 commented 15 years ago
comment:2

Yep, the ReST output does look funny, i.e. it seems that there is a lot of text that shouldn't be verbatim is rendered verbatim.

Cheers,

Michael

jhpalmieri commented 15 years ago
comment:3

Sorry about the ReST output. I was trying to balance two things, and failed. Given my limited knowledge of ReST, I can either make all of the sage output accessible to doctesting, or I can have the text indented the way I want for an enumerated list, but not both. In the new version of the patch (along with updated html on the cited web page), I've gone for the first option: doctesting sees and tests all of the examples.

(I also changed "**" to carets, since I don't care much one way or the other, and was expressed a preference.)

85eec1a4-3d04-4b4d-b711-d4db03337c41 commented 15 years ago
comment:4

Attachment: tutorial-functions.patch.gz

Merged in Sage 3.4.final.

Cheers,

Michael