Numpydocify setp. #18686
Merged
Numpydocify setp. #18686
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
Oct 7, 2020
brunobeltran
reviewed
Oct 8, 2020
lib/matplotlib/artist.py
Outdated
Comment on lines
1615
to
1616
| file : file-like or None, default: `sys.stdout` | ||
| Where `setp` writes its output, e.g. :: |
There was a problem hiding this comment.
This defaults description only makes sense if you know we're forwarding this to print, otherwise None could also plausibly interpreted to mean "no output".
Suggested change
| file : file-like or None, default: `sys.stdout` | |
| Where `setp` writes its output, e.g. :: | |
| file : file-like, optional, default: `sys.stdout` | |
| Where `setp` writes its output if it is asked to list allowed values. | |
| e.g. :: | |
| with open('output.log') as file: | |
| setp(line, file=file) | |
| Passing ``None`` forwards output to `sys.stdout`. |
brunobeltran
approved these changes
Oct 8, 2020
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
pytestpasses).flake8on changed files to check).flake8-docstringsandpydocstyle<4and 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).