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

Commitd8cf8f3

committed

Revert renaming labels to tick_labels in boxplot_stats()

This is up for debate: I'm only +0.2 here.The renaming was done in#27901, which renamed the parameter `labels`to `tick_labels` for `boxplot()` and `bxp()`.One can take two views here:- If `boxplot_stats()` is specifically for the input of `bxp()`, one can justify the renaming as being consistent with the `bxp()` signature. Note however, that the returned dict still contains the key "label" for back-compatibility. So that brings us an inconsistency between the parameter name and the returned dict key.- One can alternatively view `boxplot_stats()` as a generic function to define box parameters. Here, we'd only have a general `label` for the boy and no information that this should be used as tick label.If we could make a clean transition and also rename the dict key, Iwould tend to go with the first view. But the inevitable inconsistencyof the fist view let's me sway towards the second view, so that withthe revert, we've effectively not touched `boxplot_stats()`.

1 parent6368cc5 commitd8cf8f3Copy full SHA for d8cf8f3

File tree

1 file changed

-12

lines changed

lib/matplotlib
- cbook.py

1 file changed

-12

lines changed

`‎lib/matplotlib/cbook.py`

Lines changed: 7 additions & 12 deletions

Original file line number	Diff line number	Diff line change
`@@ -1126,8 +1126,7 @@ def _broadcast_with_masks(*args, compress=False):`
`1126`	`1126`	`returninputs`
`1127`	`1127`
`1128`	`1128`
`1129`		`-@_api.rename_parameter("3.9","labels","tick_labels")`
`1130`		`-defboxplot_stats(X,whis=1.5,bootstrap=None,tick_labels=None,`
	`1129`	`+defboxplot_stats(X,whis=1.5,bootstrap=None,labels=None,`
`1131`	`1130`	`autorange=False):`
`1132`	`1131`	`r"""`
`1133`	`1132`	`Return a list of dictionaries of statistics used to draw a series of box`
`@@ -1162,14 +1161,10 @@ def boxplot_stats(X, whis=1.5, bootstrap=None, tick_labels=None,`
`1162`	`1161`	`Number of times the confidence intervals around the median`
`1163`	`1162`	`should be bootstrapped (percentile method).`
`1164`	`1163`
`1165`		`-tick_labels :array-like, optional`
	`1164`	`+labels :list of str, optional`
`1166`	`1165`	`Labels for each dataset. Length must be compatible with`
`1167`	`1166`	`dimensions of X.`
`1168`	`1167`
`1169`		`- .. versionchanged:: 3.9`
`1170`		`- Renamed from labels, which is deprecated since 3.9`
`1171`		`- and will be removed in 3.11.`
`1172`		`-`
`1173`	`1168`	`autorange : bool, optional (False)`
`1174`	`1169`	When `True` and the data are distributed such that the 25th and 75th
`1175`	`1170`	percentiles are equal, ``whis`` is set to (0, 100) such that the
`@@ -1245,13 +1240,13 @@ def _compute_conf_interval(data, med, iqr, bootstrap):`
`1245`	`1240`	`X=_reshape_2D(X,"X")`
`1246`	`1241`
`1247`	`1242`	`ncols=len(X)`
`1248`		`-iftick_labelsisNone:`
`1249`		`-tick_labels=itertools.repeat(None)`
`1250`		`-eliflen(tick_labels)!=ncols:`
`1251`		`-raiseValueError("Dimensions oftick_labels and X must be compatible")`
	`1243`	`+iflabelsisNone:`
	`1244`	`+labels=itertools.repeat(None)`
	`1245`	`+eliflen(labels)!=ncols:`
	`1246`	`+raiseValueError("Dimensions oflabels and X must be compatible")`
`1252`	`1247`
`1253`	`1248`	`input_whis=whis`
`1254`		`-forii, (x,label)inenumerate(zip(X,tick_labels)):`
	`1249`	`+forii, (x,label)inenumerate(zip(X,labels)):`
`1255`	`1250`
`1256`	`1251`	`# empty dict`
`1257`	`1252`	`stats= {}`

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!

Commitd8cf8f3

File tree

1 file changed

1 file changed

`‎lib/matplotlib/cbook.py`

0 commit comments