Improve Figure docstrings#10595
Conversation
jklymak
left a comment
jklymak
left a comment
There was a problem hiding this comment.
This seems fine, except for the one typo (IMO) at the beginning.
|
|
||
| cax : :class:`~matplotlib.axes.Axes` object, optional | ||
| Axis into which the colorbar will be drawn | ||
| Axis into which the colorbar will be drawn. |
|
Strange. Just updated a typo in a docstring and suddenly an image comparison test fails. Did anything else in the build environment change? |
|
Yeah, I've seen the same thing. Restarting the job often gets it to pass. Not sure what causes the instability. |
|
Is there a way to restart just a specific CI service or job? Up to now, I've usually rebased in such a case, which then triggers the CI as a side effect. |
|
For Travis, you can just hit restart. For appveyor I think you need to log in and can restart. Its a bit of a pain. |
|
The failures are consistent across tests, but I'm not sure why they suddenly started appearing. |
|
From the changed rms I would assume that some commit slightly changed the output, just about enough to make this test fail. |
|
Rebased. |
| axes = property(fget=_get_axes, | ||
| doc="List of axes in the Figure. You can access and " | ||
| "modify the axes in the Figure through this list. " | ||
| "Do not modify the list itself. Instead, use " |
There was a problem hiding this comment.
the second and third sentence are contradicting each other.
There was a problem hiding this comment.
No. Assume fig.axes being [ax1, ax2]. You can access and modify ax1, e.g. fix.axes[0].set_xlim(0, 1). But you cannot add or remove an axes from the figure by fig.axes.append(ax3) or similar.
Suggestions how to describe this more clearly are welcome.
There was a problem hiding this comment.
just remove the "and modify" in the first sentence? it's not as if python had a notion of const reference anyways...
|
|
||
| def get_frameon(self): | ||
| """Get the boolean indicating frameon.""" | ||
| """Return a bool indicating whether the figure frame will be dawn.""" |
There was a problem hiding this comment.
I tend to write these just as "return whether ..." which seems less verbose and just as clear.
Also typo: dawn.
|
thanks |
Improve Figure docstrings
Conflicts:
lib/matplotlib/figure.py
- kept master version of docstring in 2 cases
6 participants
PR Summary
The title says all.