tutorial on Python object and classes

[sagetrac-mvngu]

As the subject says. See this sage-devel thread for some background information. This should be coordinated with #8470.

Apply:

1. attachment: trac_8886-objects-classes_tutorial-fh-jhp-rebased.patch

Depends on #11251
Depends on #11632

CC: @nexttime @nthiery

Component: documentation

Author: Florent Hivert, Minh Van Nguyen

Reviewer: John Palmieri

Merged: sage-4.7.2.alpha4

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

[hivert]

comment:1

I'm preparing a patch on sage-combinat queue... I took ownership of the ticket (to have it in the my ticket report).

Florent

[sagetrac-mvngu]

Attachment: trac_8886-config.patch.gz

[sagetrac-mvngu]

Author: Minh Van Nguyen

[sagetrac-mvngu]

comment:2

The patch trac_8886-config.patch contains the Sphinx configuration and build files. Such files are required to get Sphinx to build documents in the category "Thematic Tutorials". When #8468 was merged, the prerequisites listed on that ticket were not merged at all. This meant that the relevant build and configuration files did not go into Sage 4.4.1. The patch trac_8886-config.patch is an attempt to fix this. You should apply this patch prior to adding any new documents to "Thematic Tutorials".

[sagetrac-mjordan7]

comment:3

I have sage 4.3.5 and have been manually applying the doc patches. This one does not apply even though I have the prereqs. I have applied 8464, 8465, 8469, and 8442. Is that the wrong order?
~Mark

[sagetrac-mvngu]

comment:4

Replying to @sagetrac-mjordan7:

I have sage 4.3.5 and have been manually applying the doc patches. This one does not apply even though I have the prereqs.

I didn't mention that you need to apply patches on top of Sage 4.4.1. The patches on this ticket and the prequisite ticket were produced on top of Sage 4.4.1. Sorry for the inconvenience.

[jhpalmieri]

comment:6

If #8465 is merged, then trac_8886-config.patch is no longer needed.

[hivert]

Dependencies: 11251

[hivert]

Changed author from Minh Van Nguyen to Florent Hivert, Minh Van Nguyen

[hivert]

Attachment: trac_8886-objects-classes_tutorial-fh.patch.gz

[jhpalmieri]

comment:9

There is a mistake in thematic_tutorials/conf.py which prevents math like \QQ from being rendered properly. This is fixed in #11632, so I've made that a dependency for this ticket. (Please review it!)

I've fixed some typos and grammatical errors. See the "delta" patch for the differences between my patch and the previous one. I'm happy with what you've done, so if you're happy with my changes, give the ticket a positive review.

[jhpalmieri]

Changed dependencies from 11251 to #11251, #11632

[jhpalmieri]

Reviewer: John Palmieri

[jhpalmieri]

Attachment: trac_8886-delta.patch.gz

[hivert]

comment:10

Attachment: trac_8886-objects-classes_tutorial-jhp.patch.gz

Replying to @jhpalmieri:

There is a mistake in thematic_tutorials/conf.py which prevents math like
\QQ from being rendered properly. This is fixed in #11632, so I've made
that a dependency for this ticket. (Please review it!)

I'll do it.

I've fixed some typos and grammatical errors. See the "delta" patch for the
differences between my patch and the previous one. I'm happy with what
you've done, so if you're happy with my changes, give the ticket a positive
review.

Thanks for correcting my bad English. I'm mostly happy with your change. The
only remark I have is the removal of the link
:ref:`tutorial-programming-python`. It is an up coming tutorial which is
not yet fully finished. I'm creating a new ticket (#11633) and reinstating the pointer
there.

Thanks for your careful review.

Florent

[hivert]

comment:13

Nicolas pointed out the following typo:

line 14:

functions (see the "Programming" section of the Sage tutorial) -- but now further +knowledge

"now" should be "no". I'm updating a corrected patch.

[hivert]

Attachment: trac_8886-objects-classes_tutorial-fh-jhp.patch.gz

[hivert]

comment:14

New new patch is updated it should be reviewed. The diff from the preceding patch is:

1.1 --- a/trac_8886-objects-classes_tutorial-fh-jhp.patch Wed Aug 31 09:50:46 2011 +0200 
1.2 +++ b/trac_8886-objects-classes_tutorial-fh-jhp.patch Wed Aug 31 11:37:04 2011 +0200 
1.3 @@ -890,7 +890,7 @@ 
1.4 +This tutorial is an introduction to object-oriented programming in Python and 
1.5 +Sage. It requires basic knowledge about imperative/procedural programming (the 
1.6 +most common programming style) -- that is, conditional instructions, loops, 
1.7 -+functions (see the "Programming" section of the Sage tutorial) -- but now further knowledge 
1.8 ++functions (see the "Programming" section of the Sage tutorial) -- but no further knowledge 
1.9 +about objects and classes is assumed. It is designed as an alternating 
1.10 +sequence of formal introduction and exercises. :ref:`solutions` are given at 
1.11 +the end. 

[nthiery]

comment:15

Replying to @hivert:

New new patch is updated it should be reviewed. The diff from the preceding patch is:

1.1 --- a/trac_8886-objects-classes_tutorial-fh-jhp.patch Wed Aug 31 09:50:46 2011 +0200 
1.2 +++ b/trac_8886-objects-classes_tutorial-fh-jhp.patch Wed Aug 31 11:37:04 2011 +0200 
1.3 @@ -890,7 +890,7 @@ 
1.4 +This tutorial is an introduction to object-oriented programming in Python and 
1.5 +Sage. It requires basic knowledge about imperative/procedural programming (the 
1.6 +most common programming style) -- that is, conditional instructions, loops, 
1.7 -+functions (see the "Programming" section of the Sage tutorial) -- but now further knowledge 
1.8 ++functions (see the "Programming" section of the Sage tutorial) -- but no further knowledge 
1.9 +about objects and classes is assumed. It is designed as an alternating 
1.10 +sequence of formal introduction and exercises. :ref:`solutions` are given at 
1.11 +the end. 

I suggested that tiny change, so positive review on it :-)

[jdemeyer]

comment:16

Attachment: trac_8886-objects-classes_tutorial-fh-jhp-rebased.patch.gz

[jdemeyer]

Merged: sage-4.7.2.alpha4