Improve path.py docstrings a bit
#20924
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
dpoznik
commented
Aug 27, 2021
| @@ -109,7 +109,7 @@ def __init__(self, vertices, codes=None, _interpolation_steps=1, | |||
| handled correctly by the Agg PathIterator and other consumers of | |||
| path data, such as :meth:`iter_segments`. | |||
| codes : array-like or None, optional | |||
| n-length array integers representing the codes of the path. | |||
| N-length array of integers representing the codes of the path. | |||
There was a problem hiding this comment.
Capitalized to match the number of rows in vertices.
story645
approved these changes
Aug 27, 2021
timhoffm
approved these changes
Aug 27, 2021
|
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulation you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon! Remember to remove If these instruction are inaccurate, feel free to suggest an improvement. |
|
@meeseeksdev backport to v3.5.x The failure is simply that the previous backport was not merged yet. |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Aug 27, 2021
tacaswell
added a commit
that referenced
this pull request
Aug 28, 2021
…924-on-v3.5.x Backport PR #20924 on branch v3.5.x (Improve `path.py` docstrings a bit)
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
This change fixes some wording in the
path.pydocumentation, most substantively "vertex types" → "path codes". It is a follow-up to #20920 with some issues I noticed after that PR merged.PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).