Add explanatory comments for text rotation example #13469
Conversation
| @@ -3,7 +3,14 @@ | |||
| Demo Text Rotation Mode | |||
| ======================= | |||
|
|
|||
| The axes method text takes an argument rotation_mode that controls the | |||
There was a problem hiding this comment.
You can format the name of methods to directly link to the respective method, and format other code in monospace font, e.g.
| The axes method text takes an argument rotation_mode that controls the | |
| The axes' method `~.axes.Axes.text` takes an argument ``rotation_mode`` that controls the |
There was a problem hiding this comment.
Thanks! I'll make that change everywhere in the docstring.
fce978f to
138145a
Compare
|
Question: I imported matplotlib at the top of the file just so I could make a link in the references section. Is that the correct way to do things? |
|
Well, it's not wrong at least. I think I would prefer to keep it down in the references and instead add the respective flake exception, that is create a similar line to Line 233 in 2884058 for this example. |
| controls the alignment and rotation of the text. If ``rotation_mode`` is | ||
| ``None`` or ``default`` the text will first be rotated and then aligned | ||
| according to the horizontal and vertical alignments (``ha`` and ``va`` in the | ||
| example). If ``rotation_mode`` is ``anchor`` the text is aligned before rotation. |
There was a problem hiding this comment.
This line is too long. We have a limit of 80 characters per line enforced by flake.
138145a to
d5ea808
Compare
|
@ImportanceOfBeingErnest I moved the import statement to the references section and added the flake8 exception as you suggested. |
|
Thanks very much @mollyrossow for yet another helpul documentation improvement. |
…469-on-v3.0.2-doc Backport PR #13469 on branch v3.0.2-doc (Add explanatory comments for text rotation example)
…469-on-v3.0.x Backport PR #13469 on branch v3.0.x (Add explanatory comments for text rotation example)
|
Thanks @mollyrossow ! |
PR Summary
This pull request adds explanatory text to the text rotation gallery example in response to issue #11654.
PR Checklist