diff options
| author | Ross Barnowski <rossbar@berkeley.edu> | 2020-03-12 01:26:06 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-12 10:26:06 +0200 |
| commit | 5cfc2d3ca06fb6afc95c16db172f710ed6e7eed4 (patch) | |
| tree | d89d6946c296a05714f08d466d26b1e4247b72fc /doc/source/reference/routines.polynomials.rst | |
| parent | ef0957302c6383524448cef2cd4cf18c7da18ea8 (diff) | |
| download | numpy-5cfc2d3ca06fb6afc95c16db172f710ed6e7eed4.tar.gz | |
DOC: Refactor `np.polynomial` docs using `automodule` (#15662)
* DOC: Refactor polynomial docs using automodule.
Diffstat (limited to 'doc/source/reference/routines.polynomials.rst')
| -rw-r--r-- | doc/source/reference/routines.polynomials.rst | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/doc/source/reference/routines.polynomials.rst b/doc/source/reference/routines.polynomials.rst index e85d0549b..e74c5a683 100644 --- a/doc/source/reference/routines.polynomials.rst +++ b/doc/source/reference/routines.polynomials.rst @@ -1,15 +1,17 @@ +.. _routines.polynomial: + Polynomials *********** Polynomials in NumPy can be *created*, *manipulated*, and even *fitted* using -the :doc:`routines.polynomials.classes` +the :doc:`convenience classes <routines.polynomials.classes>` of the `numpy.polynomial` package, introduced in NumPy 1.4. Prior to NumPy 1.4, `numpy.poly1d` was the class of choice and it is still available in order to maintain backward compatibility. However, the newer Polynomial package is more complete than `numpy.poly1d` and its convenience classes are better behaved in the numpy environment. -Therefore Polynomial is recommended for new coding. +Therefore :mod:`numpy.polynomial` is recommended for new coding. Transition notice ----------------- @@ -22,9 +24,17 @@ degree i. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 + + routines.polynomials.classes + routines.polynomials.polynomial + routines.polynomials.chebyshev + routines.polynomials.hermite + routines.polynomials.hermite_e + routines.polynomials.laguerre + routines.polynomials.legendre + routines.polynomials.polyutils - routines.polynomials.package .. toctree:: :maxdepth: 2 |