NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.4k

Commitbdcaab5

committed

Adjust documentation and test formatting

1 parent5995c58 commitbdcaab5Copy full SHA for bdcaab5

File tree

2 files changed

+23

-15

lines changed

lib/matplotlib
- axes
  - _axes.py
- tests
  - test_axes.py

2 files changed

+23

-15

lines changed

`‎lib/matplotlib/axes/_axes.py`

Lines changed: 17 additions & 13 deletions

Original file line number	Diff line number	Diff line change
`@@ -5923,7 +5923,7 @@ def hist(self, x, bins=None, range=None, density=None, weights=None,`
`5923`	`5923`
`5924`	`5924`	Default is ``None``
`5925`	`5925`
`5926`		`- normed or density : boolean, optional`
	`5926`	`+ normed, density : boolean, optional`
`5927`	`5927`	`Either the 'normed' or the 'density' arg can be set to`
`5928`	`5928`	`accomplish this behavior:`
`5929`	`5929`
`@@ -5945,19 +5945,21 @@ def hist(self, x, bins=None, range=None, density=None, weights=None,`
`5945`	`5945`	`weights : (n, ) array_like or None, optional`
`5946`	`5946`	An array of weights, of the same shape as `x`. Each value in `x`
`5947`	`5947`	`only contributes its associated weight towards the bin count`
`5948`		- (instead of 1). If `normed` and/or 'density' is True, the weights are normalized,
`5949`		`- so that the integral of the density over the range remains 1.`
	`5948`	+ (instead of 1). If `normed` and/or 'density' is True,
	`5949`	`+ the weights are normalized, so that the integral of the density`
	`5950`	`+ over the range remains 1.`
`5950`	`5951`
`5951`	`5952`	Default is ``None``
`5952`	`5953`
`5953`	`5954`	`cumulative : boolean, optional`
`5954`	`5955`	If `True`, then a histogram is computed where each bin gives the
`5955`	`5956`	`counts in that bin plus all bins for smaller values. The last bin`
`5956`		- gives the total number of datapoints. If `normed` and/or 'density' is also `True`
`5957`		`- then the histogram is normalized such that the last bin equals 1.`
`5958`		- If `cumulative` evaluates to less than 0 (e.g., -1), the direction
`5959`		- of accumulation is reversed. In this case, if `normed` and/or 'density' is also
`5960`		- `True`, then the histogram is normalized such that the first bin
	`5957`	+ gives the total number of datapoints. If `normed` and/or 'density'
	`5958`	+ is also `True` then the histogram is normalized such that the last
	`5959`	+ bin equals 1. If `cumulative` evaluates to less than 0 (e.g., -1),
	`5960`	`+ the direction of accumulation is reversed. In this case, if`
	`5961`	+ `normed` and/or 'density' is also `True`, then the histogram is
	`5962`	`+ normalized such that the first bin`
`5961`	`5963`	`equals 1.`
`5962`	`5964`
`5963`	`5965`	Default is ``False``
`@@ -6077,12 +6079,14 @@ def hist(self, x, bins=None, range=None, density=None, weights=None,`
`6077`	`6079`
`6078`	`6080`	`"""`
`6079`	`6081`
`6080`		`-# This sets the density variable, if necessary, to its predecessor, 'normed.'`
`6081`		`-ifdensity!=Noneandnormed!=Noneanddensity!=normed:`
`6082`		`-raiseValueError('The density and normed arguments represent the same concept. Please set only one of them, or set them to the same value.')`
`6083`		`-elifnormed!=Noneanddensity==None:`
	`6082`	`+# Sets the density variable, if necessary, to its predecessor, 'normed.'`
	`6083`	`+ifdensityisnotNoneandnormedisnotNoneanddensityisnotnormed:`
	`6084`	`+raiseValueError('The density and normed arguments represent the '`
	`6085`	`+'same concept. Please set only one of them, or '`
	`6086`	`+'set them to the same value.')`
	`6087`	`+elifnormedisnotNoneanddensityisNone:`
`6084`	`6088`	`density=normed`
`6085`		`-elifnormed==Noneanddensity==None:`
	`6089`	`+elifnormedisNoneanddensityisNone:`
`6086`	`6090`	`density=False`
`6087`	`6091`
`6088`	`6092`	`def_normalize_input(inp,ename='input'):`

`‎lib/matplotlib/tests/test_axes.py`

Lines changed: 6 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -2541,13 +2541,13 @@ def test_hist_stacked_normed():`
`2541`	`2541`	`ax=fig.add_subplot(111)`
`2542`	`2542`	`ax.hist((d1,d2),stacked=True,normed=True)`
`2543`	`2543`
	`2544`	`+`
`2544`	`2545`	`@image_comparison(baseline_images=['hist_stacked_normed'])`
`2545`	`2546`	`deftest_hist_stacked_density():`
`2546`	`2547`	`# make some data`
`2547`	`2548`	`d1=np.linspace(1,3,20)`
`2548`	`2549`	`d2=np.linspace(0,10,50)`
`2549`		`-fig=plt.figure()`
`2550`		`-ax=fig.add_subplot(111)`
	`2550`	`+fig,ax=plt.subplots()`
`2551`	`2551`	`ax.hist((d1,d2),stacked=True,density=True)`
`2552`	`2552`
`2553`	`2553`	`withpytest.raises(ValueError):`
`@@ -3274,6 +3274,10 @@ def test_specgram_angle_freqs():`
`3274`	`3274`	`noverlap=noverlap,pad_to=pad_to,sides='onesided',`
`3275`	`3275`	`mode='phase',scale='dB')`
`3276`	`3276`
	`3277`	`+withpytest.raises(ValueError):`
	`3278`	`+ax13.specgram(y,NFFT=NFFT,Fs=Fs,`
	`3279`	`+noverlap=noverlap,pad_to=pad_to,sides='twosided',`
	`3280`	`+mode='phase',scale='dB')`
`3277`	`3281`
`3278`	`3282`
`3279`	`3283`	`@image_comparison(baseline_images=['specgram_angle_noise'],`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commitbdcaab5

File tree

2 files changed

2 files changed

`‎lib/matplotlib/axes/_axes.py`

`‎lib/matplotlib/tests/test_axes.py`

0 commit comments