#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 nbruin):
Replying to [comment:8 schymans]:
> 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)
> }}}
At least one occurrence of that is in the doctest of
`sage.symbolic.function_factory.function`, which (now) goes out of its way
to import ''that'' function, which does ''not'' have the side-effect of
mutating the global scope, as documented. So the assignment is actually
necessary.
Another independent point: the top-level `function` does refer to
`sage.symbolic.function_factory.function`, but perhaps should do so more
explicitly, if possible with a hyperlink. The examples on the latter are a
little more elaborate, so someone who wants to read up on `function` (and
would probably find the top-level documentation first via `sage:
function?`). I don't know how to make hyperlinks to other documentation in
sage's docstrings.
--
Ticket URL: <http://trac.sagemath.org/ticket/17447#comment:9>
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.
