Commit1e8286d

authored

Merge pull request#21362 from timhoffm/errorbar-note

Simplify wording of allowed errorbar() error values

2 parents60466fb +977bff2 commit1e8286dCopy full SHA for 1e8286d

File tree

+14

-11

lines changed

+14

-11

lines changed

Lines changed: 5 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -3181,7 +3181,7 @@ def errorbar(self, x, y, yerr=None, xerr=None,`
`3181`	`3181`	`errors.`
`3182`	`3182`	`- None: No errorbar.`
`3183`	`3183`
`3184`		`-Note that all error arrays should have non-negative values.`
	`3184`	`+All values must be >= 0.`
`3185`	`3185`
`3186`	`3186`	See :doc:`/gallery/statistics/errorbar_features`
`3187`	`3187`	for an example on the usage of ``xerr`` and ``yerr``.
`@@ -3293,9 +3293,10 @@ def has_negative_values(array):`
`3293`	`3293`	`exceptTypeError:# if array contains 'datetime.timedelta' types`
`3294`	`3294`	`returnnp.any(array<timedelta(0))`
`3295`	`3295`
`3296`		`-ifhas_negative_values(xerr)orhas_negative_values(yerr):`
`3297`		`-raiseValueError(`
`3298`		`-"'xerr' and 'yerr' must have non-negative values")`
	`3296`	`+ifhas_negative_values(xerr):`
	`3297`	`+raiseValueError("'xerr' must not contain negative values")`
	`3298`	`+ifhas_negative_values(yerr):`
	`3299`	`+raiseValueError("'yerr' must not contain negative values")`
`3299`	`3300`
`3300`	`3301`	`ifisinstance(errorevery,Integral):`
`3301`	`3302`	`errorevery= (0,errorevery)`

Lines changed: 9 additions & 7 deletions

Original file line number	Diff line number	Diff line change
`@@ -3514,18 +3514,20 @@ def test_errorbar_every_invalid():`
`3514`	`3514`	`ax.errorbar(x,y,yerr,errorevery='foobar')`
`3515`	`3515`
`3516`	`3516`
`3517`		`-deftest_xerr_yerr_positive():`
	`3517`	`+deftest_xerr_yerr_not_negative():`
`3518`	`3518`	`ax=plt.figure().subplots()`
`3519`	`3519`
`3520`		`-error_message="'xerr' and 'yerr' must have non-negative values"`
`3521`		`-`
`3522`		`-withpytest.raises(ValueError,match=error_message):`
	`3520`	`+withpytest.raises(ValueError,`
	`3521`	`+match="'xerr' must not contain negative values"):`
`3523`	`3522`	`ax.errorbar(x=[0],y=[0],xerr=[[-0.5], [1]],yerr=[[-0.5], [1]])`
`3524`		`-withpytest.raises(ValueError,match=error_message):`
	`3523`	`+withpytest.raises(ValueError,`
	`3524`	`+match="'xerr' must not contain negative values"):`
`3525`	`3525`	`ax.errorbar(x=[0],y=[0],xerr=[[-0.5], [1]])`
`3526`		`-withpytest.raises(ValueError,match=error_message):`
	`3526`	`+withpytest.raises(ValueError,`
	`3527`	`+match="'yerr' must not contain negative values"):`
`3527`	`3528`	`ax.errorbar(x=[0],y=[0],yerr=[[-0.5], [1]])`
`3528`		`-withpytest.raises(ValueError,match=error_message):`
	`3529`	`+withpytest.raises(ValueError,`
	`3530`	`+match="'yerr' must not contain negative values"):`
`3529`	`3531`	`x=np.arange(5)`
`3530`	`3532`	`y= [datetime.datetime(2021,9,i*2+1)foriinx]`
`3531`	`3533`	`ax.errorbar(x=x,`

Comments

(0)