#14090: Thematic tutorials: using the notebook, programming python, 
comprehensions
-----------------------------------------------------------------------------+
       Reporter:  nthiery                                                    |  
       Owner:  mvngu                           
           Type:  enhancement                                                |  
      Status:  needs_review                    
       Priority:  major                                                      |  
   Milestone:  sage-5.7                        
      Component:  documentation                                              |  
  Resolution:                                  
       Keywords:  thematic tutorials                                         |  
 Work issues:                                  
Report Upstream:  N/A                                                        |  
   Reviewers:  Samuel Lelièvre, Sébastien Labbé
        Authors:  Franco Saliola, Florent Hivert, Nicolas M. Thiéry, et al.  |  
   Merged in:                                  
   Dependencies:                                                             |  
    Stopgaps:                                  
-----------------------------------------------------------------------------+

Comment (by kcrisman):

 Here come some comments.  First, generalities about the front page.

 > Or should the PREP tutorial be simply merged in the thematic tutorials
 (is there a compelling reason to have separate documents?)

 Maybe not any more.  At the time the thematic tutorials were pretty
 clearly ''thematic'' tutorials.  Not really a lot of overlap between
 abelian sandpiles and an intro to doing calculus in Sage.  In any case,
 one should keep existing links working.

 Maybe that would be a next step - re-organizing ''all'' information in the
 Sage references.  Currently there is also
  * Three Lectures about Explicit Methods in Number Theory Using Sage
  * Numerical Sage
  * A Tour of Sage
  * Constructions

 Some of these things have been translated, which gives additional
 annoyance...

 {{{
 This is an index, grouped by theme, of Sage demonstrations, quick
 reference cards, primers, and thematic tutorials:
 }}}
 I only see primers and thematic tutorials.  Is this old language?

 Also, what is the reason for the different formatting - there is italic,
 regular, bold, and even tt - on the front page?

 ----

 With respect to the iteration tutorial, on request of nthiery
 höchstpersönlich!  Mostly very minor English stuff.
  * What is the plural of "syntax"?  I would use "syntaxes" as a common
 variant.
 {{{
  You can use either of the following syntax:
 }}}
  * Needs comma, probably.
 {{{
 For example here
 }}}
  * An ''extremely'' useful addition is
 {{{
 sage: [i^2 if i%2 == 1 else 2 for i in range(10)]
 [2, 1, 2, 9, 2, 25, 2, 49, 2, 81]
 }}}
    The syntax has to be perfect.  Does this work for ones with also `for j
 in range(10)` and so forth?
  * This phrase has no end-parenthesis.
 {{{
 (hint:use srange() ...
 }}}
  * "built"
 {{{
 Iterators are build using parentheses:
 }}}
  * "Iterators can be used as arguments" or "An iterator can be used ..." -
 I think you mean the latter, though.
 {{{
 An iterators can
 }}}
  * With respect to this:
 {{{
 You can get the list of the results that are not yet consumed:
 }}}
    What happens if you try to continue the iterator now?  I think that
 would be useful to warn folks.
 {{{
 sage: it.next()
 ---------------------------------------------------------------------------
 StopIteration                             Traceback (most recent call
 last)

 StopIteration:
 }}}
  * "give the same result; however, the second"
 {{{
 give the same results; however the second
 }}}
  * Show this with an example and `timeit` or something.  Maybe untested.
 {{{
 Using a list would be much slower here:
 }}}
  * "counter example" should be one word in English.
  * "and a function with tests" should be "and a function which tests
  * "interesting but demonstrating" ''could'' be "interesting beyond
 demonstrating", though that is more of a style choice
  * "Finally many" should be "Finally, many"
  * Make sure these are marked ` # not tested`!
 {{{
 sage: for p in Partitions(): print p
 sage: for p in Primes(): print p
 }}}
  * Finally, I think that something about iterables should mention `zip`
 and friends.  Or is that in a previous tutorial?

 Overall I like it, though!

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/14090#comment:17>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica, 
and MATLAB

-- 
You received this message because you are subscribed to the Google Groups 
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.


Reply via email to