8000 Update hist2d() doc. · matplotlib/matplotlib@5886744 · GitHub
[go: up one dir, main page]

Skip to content

Commit 5886744

Browse files
committed
Update hist2d() doc.
1 parent b1ae81c commit 5886744

File tree

1 file changed

+21
-24
lines changed

1 file changed

+21
-24
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 21 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6858,42 +6858,39 @@ def hist2d(self, x, y, bins=10, range=None, density=False, weights=None,
68586858
68596859
The bin specification:
68606860
6861-
- If int, the number of bins for the two dimensions
6862-
(nx=ny=bins).
6863-
6864-
- If ``[int, int]``, the number of bins in each dimension
6865-
(nx, ny = bins).
6866-
6867-
- If array_like, the bin edges for the two dimensions
6868-
(x_edges=y_edges=bins).
6869-
6870-
- If ``[array, array]``, the bin edges in each dimension
6871-
(x_edges, y_edges = bins).
6861+
- If int, the number of bins for the two dimensions
6862+
(nx=ny=bins).
6863+
- If ``[int, int]``, the number of bins in each dimension
6864+
(nx, ny = bins).
6865+
- If array_like, the bin edges for the two dimensions
6866+
(x_edges=y_edges=bins).
6867+
- If ``[array, array]``, the bin edges in each dimension
6868+
(x_edges, y_edges = bins).
68726869
68736870
The default value is 10.
68746871
68756872
range : array_like shape(2, 2), optional, default: None
6876-
The leftmost and rightmost edges of the bins along each dimension
6877-
(if not specified explicitly in the bins parameters): ``[[xmin,
6878-
xmax], [ymin, ymax]]``. All values outside of this range will be
6879-
considered outliers and not tallied in the histogram.
6873+
The leftmost and rightmost edges of the bins along each dimension
6874+
(if not specified explicitly in the bins parameters): ``[[xmin,
6875+
xmax], [ymin, ymax]]``. All values outside of this range will be
6876+
considered outliers and not tallied in the histogram.
68806877
68816878
density : bool, optional, default: False
6882-
Normalize histogram. *normed* is a deprecated synonym for this
6883-
parameter.
6879+
Normalize histogram. *normed* is a deprecated synonym for this
6880+
parameter.
68846881
68856882
weights : array_like, shape (n, ), optional, default: None
68866883
An array of values w_i weighing each sample (x_i, y_i).
68876884
68886885
cmin : scalar, optional, default: None
6889-
All bins that has count less than cmin will not be displayed and
6890-
these count values in the return value count histogram will also
6891-
be set to nan upon return
6886+
All bins that has count less than cmin will not be displayed (set
6887+
to NaN before passing to imshow) and these count values in the
6888+
return value count histogram will also be set to nan upon return.
68926889
68936890
cmax : scalar, optional, default: None
6894-
All bins that has count more than cmax will not be displayed (set
6895-
to none before passing to imshow) and these count values in the
6896-
return value count histogram will also be set to nan upon return
6891+
All bins that has count more than cmax will not be displayed (set
6892+
to NaN before passing to imshow) and these count values in the
6893+
return value count histogram will also be set to nan upon return.
68976894
68986895
Returns
68996896
-------
@@ -6929,7 +6926,7 @@ def hist2d(self, x, y, bins=10, range=None, density=False, weights=None,
69296926
69306927
Notes
69316928
-----
6932-
- Currently ``hist2d`` calculates it's own axis limits, and any limits
6929+
- Currently ``hist2d`` calculates its own axis limits, and any limits
69336930
previously set are ignored.
69346931
- Rendering the histogram with a logarithmic color scale is
69356932
accomplished by passing a `.colors.LogNorm` instance to the *norm*

0 commit comments

Comments
 (0)
0