Use :mpltype:color for color types
#27557
Conversation
|
I'm unclear why the doc build is failing. I've only added |
|
Found the bug in the |
e1d4154 to
6df7c6d
Compare
lib/matplotlib/axes/_axes.py
Outdated
| @@ -1073,7 +1073,7 @@ def hlines(self, y, xmin, xmax, colors=None, linestyles='solid', | |||
| Respective beginning and end of each line. If scalars are | |||
| provided, all lines will have the same length. | |||
|
|
|||
| colors : color or list of colors, default: :rc:`lines.color` | |||
| colors : :mpltype:`color` or list of colors, default: :rc:`lines.color` | |||
There was a problem hiding this comment.
Why is this one list of colors, while the others were changed to list of color (and some others where changed to list of :mpltype:'color')?
There was a problem hiding this comment.
-
The canoncial description is "list of [type]", i.e. should be "list of color". However, this is currently quite inconsistent. I've only changed it when changing the text anyway.
-
For "color or list of color" I've refrained from linking the second color if that would make a a line continuation necessary. But that's debatable of course.
lib/matplotlib/quiver.py
Outdated
| @@ -179,7 +179,7 @@ | |||
| Minimum length as a multiple of shaft width; if an arrow length | |||
| is less than this, plot a dot (hexagon) of this diameter instead. | |||
|
|
|||
| color : color or color sequence, optional | |||
| color : :mpltype:`color` or color sequence, optional | |||
There was a problem hiding this comment.
Should color sequence here be list of :mpltype:color?
There was a problem hiding this comment.
Fixed. - On a general note, I've used a couple of search/replace patterns. It is likely that I have not found all color type definitions with that. I think it's enough to start with the bulk here and fix others later if we find them.
|
Semi-OT: I don't think our GitHub auto-labeling (ref. #27633) makes much sense here. Can we fine-tune this. Or make deactivation possible (maybe through a "no-auto-label" label)? Or should we just live with it? |
`inline.interpreted()` already returns a list of nodes. We mustn't wrap it in another list.
It only cares about file names, so you can't have it ignore PRs where just docstring are touched, for example. |
Follow up to #27200.