Cleanup anchored_artists, inset_locator docstrings. #20090
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
- Prefer string locations to integers (reusing the description used in the base AnchoredOffsetbox class). Also switch from bullet list to plain text list (with correct layout in asciiart), as I think having the whole docstring fit in one screenful is also nice. - Likewise, suppress blank lines between parameters (when all parameters have a single-paragraph description) to avoid really long docstrings. - Group axes_class and axes_kwargs parameters together; also very slightly cleanup the implementation. - Minor typo fixes.
QuLogic
approved these changes
Apr 27, 2021
timhoffm
approved these changes
Apr 28, 2021
7 tasks
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.
the base AnchoredOffsetbox class). Also switch from bullet list to
plain text list (with correct layout in asciiart), as I think having
the whole docstring fit in one screenful is also nice.
have a single-paragraph description) to avoid really long docstrings.
slightly cleanup the implementation.
PR Summary
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).