Expand docs on panzoom rect setter #2317
Merged
Conversation
This file contains 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
djhoese
requested changes
Apr 1, 2022
vispy/scene/cameras/panzoom.py
Outdated
Comment on lines
135
to
137
| """The rectangular border of the ViewBox visible area, expressed in | ||
| the coordinate system of the scene. | ||
| the coordinate system of the scene. See `~vispy.geometry.rect.Rect` | ||
| for different ways this can be specified. |
There was a problem hiding this comment.
I think you need a :class: at the beginning of your Rect reference. Additionally, we should clean up this docstring to meet flake8 standards (current disabled on CI I think). What about...
"""Set the rectangular border of the ViewBox visible area.
This is expressed in the coordinate system of the scene. See :class:`~vispy.geometry.rect.Rect`
for different ways this can be specified.
Thoughts?
|
👍 I've updated as requested. I was lazy and did it through the GH UI though, so hopefully everything is fine? If not I can fork and do it properley locally. |
|
Looks good to me. Thanks!
|
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.
This adds a reference to the ways the view rectangle can be specified, clearing up potential confusion. Fixes #2316.