docs: improve bounds_to_vertices and vertices_to_bounds docstrings#642
Open
SAY-5 wants to merge 1 commit into
Open
docs: improve bounds_to_vertices and vertices_to_bounds docstrings#642SAY-5 wants to merge 1 commit into
SAY-5 wants to merge 1 commit into
Conversation
dcherian
approved these changes
May 19, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Addresses the docstring numpydoc warnings in #322 for the two public
helpersfunctions: single-line summary (SS06), a description for the return value ofvertices_to_bounds(RT03), and aSee Alsosection plus runnableExamples(SA01, EX01) for both functions. The issue notes it "would be good to clean up these warnings".