diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2011-06-18 13:22:06 -0600 |
|---|---|---|
| committer | rgommers <ralf.gommers@googlemail.com> | 2011-06-20 22:14:02 +0200 |
| commit | 008c9318789050ee53b3bd420b3610cf4c4f338e (patch) | |
| tree | 115a39575c8d375d6d02cf52c9eb77e6b2c7abf4 /doc | |
| parent | 4e52c48bd37abdce856033f48d3ce9c0a8c5483f (diff) | |
| download | numpy-008c9318789050ee53b3bd420b3610cf4c4f338e.tar.gz | |
ENH: Add the polynomial module to the documentation.
Also:
1. Note that the polynomial package is preferred over poly1d.
2. Remove deprecation of mapparms in __init__.py as it interferes with the
documention of the method of the same name. This is probably safe as it
is unlikely to be used yet.
3. Make some improvements to the documentation in polytemplate.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/reference/routines.polynomials.poly1d.rst (renamed from doc/source/reference/routines.poly.rst) | 4 | ||||
| -rw-r--r-- | doc/source/reference/routines.polynomials.polynomial.rst | 16 | ||||
| -rw-r--r-- | doc/source/reference/routines.polynomials.rst | 14 | ||||
| -rw-r--r-- | doc/source/reference/routines.rst | 2 |
4 files changed, 33 insertions, 3 deletions
diff --git a/doc/source/reference/routines.poly.rst b/doc/source/reference/routines.polynomials.poly1d.rst index f30b2c884..7eef53ce2 100644 --- a/doc/source/reference/routines.poly.rst +++ b/doc/source/reference/routines.polynomials.poly1d.rst @@ -1,5 +1,5 @@ -Polynomials -*********** +Poly1d +====== .. currentmodule:: numpy diff --git a/doc/source/reference/routines.polynomials.polynomial.rst b/doc/source/reference/routines.polynomials.polynomial.rst new file mode 100644 index 000000000..aa92ce8fc --- /dev/null +++ b/doc/source/reference/routines.polynomials.polynomial.rst @@ -0,0 +1,16 @@ +Polynomial Package (:mod:`numpy.polynomial`) +============================================ + +.. currentmodule:: numpy.polynomial + +Polynomial Classes +------------------ +.. autosummary:: + :toctree: generated/ + + Polynomial + Chebyshev + Legendre + Hermite + HermiteE + Laguerre diff --git a/doc/source/reference/routines.polynomials.rst b/doc/source/reference/routines.polynomials.rst new file mode 100644 index 000000000..59d6bc499 --- /dev/null +++ b/doc/source/reference/routines.polynomials.rst @@ -0,0 +1,14 @@ +Polynomials +*********** + +The poly1d functions are considered outdated but are retained for +backward compatibility. New software needing polynomials should +use the classes in the Polynomial Package. + +.. toctree:: + :maxdepth: 2 + + routines.polynomials.polynomial + routines.polynomials.poly1d + + diff --git a/doc/source/reference/routines.rst b/doc/source/reference/routines.rst index c97a3d244..fb53aac3b 100644 --- a/doc/source/reference/routines.rst +++ b/doc/source/reference/routines.rst @@ -29,7 +29,7 @@ indentation. routines.statistics routines.math routines.functional - routines.poly + routines.polynomials routines.datetime routines.financial routines.set |