#17447: Clarify and complete documentation of function()
-------------------------------------+-------------------------------------
       Reporter:  schymans           |        Owner:
           Type:  enhancement        |       Status:  needs_review
       Priority:  major              |    Milestone:  sage-6.5
      Component:  documentation      |   Resolution:
       Keywords:                     |    Merged in:
        Authors:  schymans           |    Reviewers:
Report Upstream:  N/A                |  Work issues:
         Branch:                     |       Commit:
  u/nbruin/clarify_and_complete_documentation_of_function__|  
fa3ebd6645eb2cae45c2218628eaa1d984f16506
   Dependencies:                     |     Stopgaps:
-------------------------------------+-------------------------------------

Comment (by schymans):

 Replying to [comment:7 nbruin]:
 > Not really ready for *review* but is ready for input. And is mainly
 ready for someone else to rewrite documentation properly. People CC'd on
 this ticket look like good candidates to do so.
 > ----
 > New commits:
 >
 
||[http://git.sagemath.org/sage.git/commit/?id=b41248b13e18744ab9902adde9b7740832bb1724
 b41248b]||{{{trac 17447: Deprecation of function('f',x) in favour of
 function('f')(x)}}}||
 >
 
||[http://git.sagemath.org/sage.git/commit/?id=fa3ebd6645eb2cae45c2218628eaa1d984f16506
 fa3ebd6]||{{{trac 17447: Doctest changes to reflect deprecation of
 function('f',x)}}}||
 > ----
 > note that the doctest that apparently got removed in b41248b in reality
 gets moved to var.pyx because it tests the toplevel `function`, not the
 library `function`

 This makes it a lot clearer to me now. Just a minor thing:
 In one of the examples, I would replace
 {{{
 sage: cr = function('cr')
 sage: f = cr(a)
 }}}

 by

 {{{
 sage: function('cr')
 sage: f = cr(a)
 }}}

 which in my understanding does the same but is shorter and makes clear
 that `function('cr')` does already create a symbolic function called `cr`.
 Otherwise, one may be surprised to create two functions by typing e.g.
 `cr1 = function('cr')`.

--
Ticket URL: <http://trac.sagemath.org/ticket/17447#comment:8>
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.
For more options, visit https://groups.google.com/d/optout.

Reply via email to