#11209: documentation for symbolic series function is wrong/misleading
-------------------------+--------------------------------------------------
Reporter: was | Owner: burcin
Type: defect | Status: new
Priority: minor | Milestone: sage-4.7
Component: symbolics | Keywords:
Author: | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-------------------------+--------------------------------------------------
Consider:
{{{
sage: f(x) = log(x)
sage: f.series?
Definition: f.series(self, symbol, order)
Docstring:
Return the power series expansion of self in terms of the variable
symbol to the given order.
INPUT:
INPUT:
* ``symbol`` - a variable
* ``order`` - an integer
OUTPUT:
* a power series
To truncate the power series and obtain a normal expression, use
the truncate command.
EXAMPLES:
We expand a polynomial in x about 0, about 1, and also truncate it
back to a polynomial:
sage: g = f.series(x, 4); g
3 + (-5)*x + (-sin(y))*x^2 + 1*x^3
sage: g.truncate()
x^3 - x^2*sin(y) - 5*x + 3
sage: g = f.series(x==1, 4); g
}}}
This is wrong in that:
* the first input should not be called "symbol", since it can also be a
symbolic expression of the form variable==number.
* the description of the first argument "symbol" in the INPUT block says
it has to be a variable, but the examples, etc., clearly shows it doesn't
have to be.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/11209>
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 post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
