Docstrings for _qhull. #22342
Merged
Docstrings for _qhull. #22342
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
QuLogic
approved these changes
Jan 29, 2022
| "Parameters\n" | ||
| "----------\n" | ||
| "x, y : 1d arrays\n" | ||
| " The coordinates of the point set, which must consist of at least \n" |
There was a problem hiding this comment.
Trailing whitespace, sort of:
Suggested change
| " The coordinates of the point set, which must consist of at least \n" | |
| " The coordinates of the point set, which must consist of at least\n" |
|
Is this rendered somewhere in the docs? |
|
It's private and not rendered, but still useful if someone wants to check what these internal functions are doing (e.g., via pydoc or via ipython's |
timhoffm
approved these changes
Jan 29, 2022
6 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.
PR Summary
PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).