Skip to content

Backport PR #23887 on branch v3.6.x (Add missing label argument to barh docs) #23897

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
merged 1 commit into from
Sep 15, 2022
Merged

Backport PR #23887 on branch v3.6.x (Add missing label argument to barh docs) #23897

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
48 changes: 30 additions & 18 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2228,7 +2228,7 @@ def bar(self, x, height, width=0.8, bottom=None, *, align="center",
The width(s) of the bars.

bottom : float or array-like, default: 0
The y coordinate(s) of the bars bases.
The y coordinate(s) of the bottom side(s) of the bars.

align : {'center', 'edge'}, default: 'center'
Alignment of the bars to the *x* coordinates:
Expand Down Expand Up @@ -2278,8 +2278,8 @@ def bar(self, x, height, width=0.8, bottom=None, *, align="center",
errors.
- *None*: No errorbar. (Default)

See :doc:`/gallery/statistics/errorbar_features`
for an example on the usage of ``xerr`` and ``yerr``.
See :doc:`/gallery/statistics/errorbar_features` for an example on
the usage of *xerr* and *yerr*.

ecolor : color or list of color, default: 'black'
The line color of the errorbars.
Expand All @@ -2288,9 +2288,9 @@ def bar(self, x, height, width=0.8, bottom=None, *, align="center",
The length of the error bar caps in points.

error_kw : dict, optional
Dictionary of kwargs to be passed to the `~.Axes.errorbar`
method. Values of *ecolor* or *capsize* defined here take
precedence over the independent kwargs.
Dictionary of keyword arguments to be passed to the
`~.Axes.errorbar` method. Values of *ecolor* or *capsize* defined
here take precedence over the independent keyword arguments.

log : bool, default: False
If *True*, set the y-axis to be log scale.
Expand Down Expand Up @@ -2498,9 +2498,10 @@ def bar(self, x, height, width=0.8, bottom=None, *, align="center",

return bar_container

# @_preprocess_data() # let 'bar' do the unpacking..
@_docstring.dedent_interpd
def barh(self, y, width, height=0.8, left=None, *, align="center",
**kwargs):
data=None, **kwargs):
r"""
Make a horizontal bar plot.

Expand All @@ -2524,7 +2525,7 @@ def barh(self, y, width, height=0.8, left=None, *, align="center",
The heights of the bars.

left : float or array-like, default: 0
The x coordinates of the left sides of the bars.
The x coordinates of the left side(s) of the bars.

align : {'center', 'edge'}, default: 'center'
Alignment of the base to the *y* coordinates*:
Expand Down Expand Up @@ -2556,9 +2557,17 @@ def barh(self, y, width, height=0.8, left=None, *, align="center",
The tick labels of the bars.
Default: None (Use default numeric labels.)

label : str or list of str, optional
A single label is attached to the resulting `.BarContainer` as a
label for the whole dataset.
If a list is provided, it must be the same length as *y* and
labels the individual bars. Repeated labels are not de-duplicated
and will cause repeated label entries, so this is best used when
bars also differ in style (e.g., by passing a list to *color*.)

xerr, yerr : float or array-like of shape(N,) or shape(2, N), optional
If not ``None``, add horizontal / vertical errorbars to the
bar tips. The values are +/- sizes relative to the data:
If not *None*, add horizontal / vertical errorbars to the bar tips.
The values are +/- sizes relative to the data:

- scalar: symmetric +/- values for all bars
- shape(N,): symmetric +/- values for each bar
Expand All @@ -2567,8 +2576,8 @@ def barh(self, y, width, height=0.8, left=None, *, align="center",
errors.
- *None*: No errorbar. (default)

See :doc:`/gallery/statistics/errorbar_features`
for an example on the usage of ``xerr`` and ``yerr``.
See :doc:`/gallery/statistics/errorbar_features` for an example on
the usage of *xerr* and *yerr*.

ecolor : color or list of color, default: 'black'
The line color of the errorbars.
Expand All @@ -2577,13 +2586,17 @@ def barh(self, y, width, height=0.8, left=None, *, align="center",
The length of the error bar caps in points.

error_kw : dict, optional
Dictionary of kwargs to be passed to the `~.Axes.errorbar`
method. Values of *ecolor* or *capsize* defined here take
precedence over the independent kwargs.
Dictionary of keyword arguments to be passed to the
`~.Axes.errorbar` method. Values of *ecolor* or *capsize* defined
here take precedence over the independent keyword arguments.

log : bool, default: False
If ``True``, set the x-axis to be log scale.

data : indexable object, optional
If given, all parameters also accept a string ``s``, which is
interpreted as ``data[s]`` (unless this raises an exception).

**kwargs : `.Rectangle` properties

%(Rectangle:kwdoc)s
Expand All @@ -2596,12 +2609,11 @@ def barh(self, y, width, height=0.8, left=None, *, align="center",
-----
Stacked bars can be achieved by passing individual *left* values per
bar. See
:doc:`/gallery/lines_bars_and_markers/horizontal_barchart_distribution`
.
:doc:`/gallery/lines_bars_and_markers/horizontal_barchart_distribution`.
"""
kwargs.setdefault('orientation', 'horizontal')
patches = self.bar(x=left, height=height, width=width, bottom=y,
align=align, **kwargs)
align=align, data=data, **kwargs)
return patches

def bar_label(self, container, labels=None, *, fmt="%g", label_type="edge",
Expand Down
7 changes: 5 additions & 2 deletions lib/matplotlib/pyplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2367,9 +2367,12 @@ def barbs(*args, data=None, **kwargs):

# Autogenerated by boilerplate.py. Do not edit as changes will be lost.
@_copy_docstring_and_deprecators(Axes.barh)
def barh(y, width, height=0.8, left=None, *, align='center', **kwargs):
def barh(
y, width, height=0.8, left=None, *, align='center',
data=None, **kwargs):
return gca().barh(
y, width, height=height, left=left, align=align, **kwargs)
y, width, height=height, left=left, align=align,
**({"data": data} if data is not None else {}), **kwargs)


# Autogenerated by boilerplate.py. Do not edit as changes will be lost.
Expand Down