FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

DOC: Fix type descriptions in fill_between docstring by timhoffm · Pull Request #29456 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

DOC: Fix type descriptions in fill_between docstring #29456

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rcomer merged 1 commit into from
Jan 11, 2025
Conversation 0 Commits 1 Checks 0 Files changed
Merged

DOC: Fix type descriptions in fill_between docstring #29456

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .py  (2) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
8 changes: 4 additions & 4 deletions lib/matplotlib/axes/_axes.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -5582,16 +5582,16 @@ def _fill_between_x_or_y(

Parameters
----------
{ind} : array (length N)
{ind} : array-like
The {ind} coordinates of the nodes defining the curves.

{dep}1 : array (length N) or scalar
{dep}1 : array-like or float
The {dep} coordinates of the nodes defining the first curve.

{dep}2 : array (length N) or scalar, default: 0
{dep}2 : array-like or float, default: 0
The {dep} coordinates of the nodes defining the second curve.

where : array of bool (length N), optional
where : array-like of bool, optional
Define *where* to exclude some {dir} regions from being filled.
The filled regions are defined by the coordinates ``{ind}[where]``.
More precisely, fill between ``{ind}[i]`` and ``{ind}[i+1]`` if
Expand Down
16 changes: 8 additions & 8 deletions lib/matplotlib/collections.py
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -1288,16 +1288,16 @@ def __init__(
- 'x': the curves are ``(t, f1)`` and ``(t, f2)``.
- 'y': the curves are ``(f1, t)`` and ``(f2, t)``.

t : array (length N)
t : array-like
The ``t_direction`` coordinates of the nodes defining the curves.

f1 : array (length N) or scalar
f1 : array-like or float
The other coordinates of the nodes defining the first curve.

f2 : array (length N) or scalar
f2 : array-like or float
The other coordinates of the nodes defining the second curve.

where : array of bool (length N), optional
where : array-like of bool, optional
Define *where* to exclude some {dir} regions from being filled.
The filled regions are defined by the coordinates ``t[where]``.
More precisely, fill between ``t[i]`` and ``t[i+1]`` if
Expand Down Expand Up @@ -1368,16 +1368,16 @@ def set_data(self, t, f1, f2, *, where=None):

Parameters
----------
t : array (length N)
t : array-like
The ``self.t_direction`` coordinates of the nodes defining the curves.

f1 : array (length N) or scalar
f1 : array-like or float
The other coordinates of the nodes defining the first curve.

f2 : array (length N) or scalar
f2 : array-like or float
The other coordinates of the nodes defining the second curve.

where : array of bool (length N), optional
where : array-like of bool, optional
Define *where* to exclude some {dir} regions from being filled.
The filled regions are defined by the coordinates ``t[where]``.
More precisely, fill between ``t[i]`` and ``t[i+1]`` if
Expand Down
Back | FazBrowse Home | New Git URL