Skip to content

Commit a01a1df

Browse files
wqian94timhoffm
andauthored
Add markerfacealt to pass-through arguments for error bar lines (#23475)
* Add markerfacealt to pass-through arguments for error bar lines * Update documentation to reflect which kwargs errorbar() passes on * Document API changes * Refactor documentation list of supported Line2D kwargs * Update lib/matplotlib/axes/_axes.py Fix tabbing on documentation Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
1 parent 931a81f commit a01a1df

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
The markerfacecoloralt parameter to Line2D is now supported by axes.errorbar
2+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3+
- markerfacecoloralt is now passed to the line plotter from axes.errorbar
4+
- Documentation for axes.errorbar how accurately lists which properties are
5+
passed on to Line2D, rather than claiming that all kwargs are passed on

lib/matplotlib/axes/_axes.py

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3367,7 +3367,25 @@ def errorbar(self, x, y, yerr=None, xerr=None,
33673367
property names, *markerfacecolor*, *markeredgecolor*, *markersize*
33683368
and *markeredgewidth*.
33693369
3370-
Valid kwargs for the marker properties are `.Line2D` properties:
3370+
Valid kwargs for the marker properties are:
3371+
3372+
- *dashes*
3373+
- *dash_capstyle*
3374+
- *dash_joinstyle*
3375+
- *drawstyle*
3376+
- *fillstyle*
3377+
- *linestyle*
3378+
- *marker*
3379+
- *markeredgecolor*
3380+
- *markeredgewidth*
3381+
- *markerfacecolor*
3382+
- *markerfacecoloralt*
3383+
- *markersize*
3384+
- *markevery*
3385+
- *solid_capstyle*
3386+
- *solid_joinstyle*
3387+
3388+
Refer to the corresponding `.Line2D` property for more details:
33713389
33723390
%(Line2D:kwdoc)s
33733391
"""
@@ -3467,6 +3485,7 @@ def _upcast_err(err):
34673485
# Eject any line-specific information from format string, as it's not
34683486
# needed for bars or caps.
34693487
for key in ['marker', 'markersize', 'markerfacecolor',
3488+
'markerfacecoloralt',
34703489
'markeredgewidth', 'markeredgecolor', 'markevery',
34713490
'linestyle', 'fillstyle', 'drawstyle', 'dash_capstyle',
34723491
'dash_joinstyle', 'solid_capstyle', 'solid_joinstyle',

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy