summaryrefslogtreecommitdiff
path: root/numpy/polynomial/hermite.py
diff options
context:
space:
mode:
authorPaul Romano <paul.k.romano@gmail.com>2023-05-10 08:56:41 -0500
committerPaul Romano <paul.k.romano@gmail.com>2023-05-10 08:56:41 -0500
commit2aaf325dd7e1fae2a6cd6dc63031ccff040487c4 (patch)
tree095fbfe2ef935dae4a138f85f39087ca6150d7f2 /numpy/polynomial/hermite.py
parent181c15b294d6dd164e4c41ddbb1c5feae9b5beee (diff)
downloadnumpy-2aaf325dd7e1fae2a6cd6dc63031ccff040487c4.tar.gz
DOC: Add symbol in docstring for classes derived from ABCPolyBase
A 'symbol' argument was added in ABCPolyBase in 1.24 and documented there, but the docstrings for derived classes (e.g., Polynomial) were not updated.
Diffstat (limited to 'numpy/polynomial/hermite.py')
-rw-r--r--numpy/polynomial/hermite.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/numpy/polynomial/hermite.py b/numpy/polynomial/hermite.py
index e20339121..210df25f5 100644
--- a/numpy/polynomial/hermite.py
+++ b/numpy/polynomial/hermite.py
@@ -1675,6 +1675,12 @@ class Hermite(ABCPolyBase):
Window, see `domain` for its use. The default value is [-1, 1].
.. versionadded:: 1.6.0
+ symbol : str, optional
+ Symbol used to represent the independent variable in string
+ representations of the polynomial expression, e.g. for printing.
+ The symbol must be a valid Python identifier. Default value is 'x'.
+
+ .. versionadded:: 1.24
"""
# Virtual Functions