Skip to content

Commit

Permalink
DOC: Update symbol wording and add to docstrings.
Browse files Browse the repository at this point in the history
  • Loading branch information
rossbar committed Sep 22, 2020
1 parent 0ae8891 commit 5b028aa
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions numpy/polynomial/_polybase.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ class ABCPolyBase(abc.ABC):
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 non-empty string, the first character of which
is an alphabetical character. Default value is 'x'.
The symbol must be a non-empty string where the first character is
non-numeric. Default value is 'x'.
Attributes
----------
Expand Down Expand Up @@ -983,6 +983,8 @@ class domain in NumPy 1.4 and ``None`` in later versions.
value is the default class domain
.. versionadded:: 1.6.0
symbol : str, optional
Symbol representing the independent variable. Default is 'x'.
Returns
-------
Expand Down Expand Up @@ -1039,6 +1041,8 @@ def fromroots(cls, roots, domain=[], window=None, symbol='x'):
window : {None, array_like}, optional
Window for the returned series. If None the class window is
used. The default is None.
symbol : str, optional
Symbol representing the independent variable. Default is 'x'.
Returns
-------
Expand Down Expand Up @@ -1079,6 +1083,8 @@ def identity(cls, domain=None, window=None, symbol='x'):
``[beg, end]``, where ``beg`` and ``end`` are the endpoints of
the window. If None is given then the class window is used. The
default is None.
symbol : str, optional
Symbol representing the independent variable. Default is 'x'.
Returns
-------
Expand Down Expand Up @@ -1115,6 +1121,8 @@ def basis(cls, deg, domain=None, window=None, symbol='x'):
``[beg, end]``, where ``beg`` and ``end`` are the endpoints of
the window. If None is given then the class window is used. The
default is None.
symbol : str, optional
Symbol representing the independent variable. Default is 'x'.
Returns
-------
Expand Down

0 comments on commit 5b028aa

Please sign in to comment.