Skip to content

Simplify wording of allowed errorbar() error values #21362

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
jklymak merged 1 commit into from
Oct 15, 2021
Merged

Simplify wording of allowed errorbar() error values #21362

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
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3181,7 +3181,7 @@ def errorbar(self, x, y, yerr=None, xerr=None,
errors.
- *None*: No errorbar.

Note that all error arrays should have *non-negative* values.
All values must be >= 0.

See :doc:`/gallery/statistics/errorbar_features`
for an example on the usage of ``xerr`` and ``yerr``.
Expand Down Expand Up @@ -3293,9 +3293,10 @@ def has_negative_values(array):
except TypeError: # if array contains 'datetime.timedelta' types
return np.any(array < timedelta(0))

if has_negative_values(xerr) or has_negative_values(yerr):
raise ValueError(
"'xerr' and 'yerr' must have non-negative values")
if has_negative_values(xerr):
raise ValueError("'xerr' must not contain negative values")
if has_negative_values(yerr):
raise ValueError("'yerr' must not contain negative values")

if isinstance(errorevery, Integral):
errorevery = (0, errorevery)
Expand Down
16 changes: 9 additions & 7 deletions lib/matplotlib/tests/test_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3514,18 +3514,20 @@ def test_errorbar_every_invalid():
ax.errorbar(x, y, yerr, errorevery='foobar')


def test_xerr_yerr_positive():
def test_xerr_yerr_not_negative():
ax = plt.figure().subplots()

error_message = "'xerr' and 'yerr' must have non-negative values"

with pytest.raises(ValueError, match=error_message):
with pytest.raises(ValueError,
match="'xerr' must not contain negative values"):
ax.errorbar(x=[0], y=[0], xerr=[[-0.5], [1]], yerr=[[-0.5], [1]])
with pytest.raises(ValueError, match=error_message):
with pytest.raises(ValueError,
match="'xerr' must not contain negative values"):
ax.errorbar(x=[0], y=[0], xerr=[[-0.5], [1]])
with pytest.raises(ValueError, match=error_message):
with pytest.raises(ValueError,
match="'yerr' must not contain negative values"):
ax.errorbar(x=[0], y=[0], yerr=[[-0.5], [1]])
with pytest.raises(ValueError, match=error_message):
with pytest.raises(ValueError,
match="'yerr' must not contain negative values"):
x = np.arange(5)
y = [datetime.datetime(2021, 9, i * 2 + 1) for i in x]
ax.errorbar(x=x,
Expand Down