#17447: Clarify and complete documentation of function()
-------------------------+-------------------------------------------------
       Reporter:         |        Owner:
  schymans               |       Status:  needs_work
           Type:         |    Milestone:  sage-6.5
  enhancement            |   Resolution:
       Priority:  major  |    Merged in:
      Component:         |    Reviewers:  Ralf Stephan
  documentation          |  Work issues:
       Keywords:         |       Commit:
        Authors:         |  4585e74063e81a8c332a500d016e837069edf8eb
  schymans               |     Stopgaps:
Report Upstream:  N/A    |
         Branch:         |
  public/17447           |
   Dependencies:         |
-------------------------+-------------------------------------------------

Comment (by kcrisman):

 > The top-level function documentation is rather sparse, so that could use
 expansion.

 Yes, this is what I meant.  Hyperlink is tricky - not per se, but in
 command line and even sagenb it's not as useful.  So I figure at least a
 little more in the top-level and then the hyperlink (assuming that file is
 in fact already in the documentation!).

 > You are excellently qualified to produce extensive and understandable
 documentation for the target audience of these functions.

 That is very kind, I will see; this one is lower on my priority list but
 definitely important.

 > If you feel the projects benefits from such administrations, go ahead.

 Well, I've found it does.  I guess I will ask you to review it if I do
 that :-)

 > In my opinion, that's another thing to document. However, the confusion
 about function not returning a function definitely contributed to the
 confusion about how to use substitute_function.

 Yes.

--
Ticket URL: <http://trac.sagemath.org/ticket/17447#comment:20>
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