Shorten some inset_locator docstrings. #21520
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
timhoffm
reviewed
Nov 2, 2021
| @@ -251,21 +209,14 @@ def __init__(self, bbox1, bbox2, loc1, loc2=None, **kwargs): | |||
| Bounding boxes to connect. | |||
|
|
|||
| loc1 : {1, 2, 3, 4} | |||
timhoffm
reviewed
Dec 4, 2021
| x, y : float | ||
| Coordinates of the corner specified by *loc*. | ||
| Return the ``(x, y)`` coordinates of corner *loc* of *bbox*; parameters | ||
| behave as documented in ``__init__``. |
There was a problem hiding this comment.
Use:
Suggested change
| behave as documented in ``__init__``. | |
| behave as documented in `BboxConnector`. |
because that creates a link. - Maybe BboxConnector.__init__ or .__init__ would work as well, but I've not tested that; and I'm not even sure if that would be better.
Same for all other cases here.
We don't need to repeat the definition of `loc` again and again across helper functions.
timhoffm
approved these changes
Dec 5, 2021
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.
We don't need to repeat the definition of
locagain and again acrosshelper functions.
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).