Doc: document textpath module #12676
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
flake8 says |
timhoffm
reviewed
Oct 30, 2018
lib/matplotlib/textpath.py
Outdated
| The text to be converted. | ||
|
|
||
| usetex : bool | ||
| If True, use matplotlib usetex mode. |
There was a problem hiding this comment.
Do we have a link or a description what "matplotlib usetex mode" is?
There was a problem hiding this comment.
Good question. I now replaced it with
Whether to use tex rendering. Defaults to
False.
same as further down in TextPath.
lib/matplotlib/textpath.py
Outdated
| *ismath* | ||
| If True, use mathtext parser. Effective only if usetex == False. | ||
| ismath : bool | ||
| If True, use mathtext parser. Effective only if usetex == False. |
There was a problem hiding this comment.
if *usetex* is False. or if ``usetex == False``.
lib/matplotlib/textpath.py
Outdated
| ---------- | ||
|
|
||
| xy : tuple or array of two float values | ||
| Position of the text. For no offset, use ``xy=(0,0)``. |
There was a problem hiding this comment.
xy=(0, 0) (space before comma)
lib/matplotlib/textpath.py
Outdated
|
|
||
| *usetex* | ||
| If True, use matplotlib usetex mode. | ||
| s : string |
lib/matplotlib/textpath.py
Outdated
| xy : tuple or array of two float values | ||
| Position of the text. For no offset, use ``xy=(0,0)``. | ||
|
|
||
| s : string |
81583be to
9670bf9
Compare
9670bf9 to
e9101f0
Compare
NelleV
approved these changes
Nov 2, 2018
|
|
||
| Returns | ||
| ------- | ||
|
|
There was a problem hiding this comment.
FYI, you don't need blank lines after the headers.
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Nov 2, 2018
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Nov 2, 2018
timhoffm
pushed a commit
that referenced
this pull request
Nov 2, 2018
timhoffm
pushed a commit
that referenced
this pull request
Nov 2, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
The
matplotlib.textpathmodule had not been available in the documentation. This PR adds it to the list of modules and improves its docstrings.PR Checklist