Document docstring quote convention #17193
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
added a commit
to timhoffm/matplotlib
that referenced
this pull request
Mar 10, 2024
This got accidentally ignored in matplotlib#25147. We want D213 (matplotlib#17125, matplotlib#17193) https://matplotlib.org/devdocs/devel/document.html#quote-positions
timhoffm
added a commit
to timhoffm/matplotlib
that referenced
this pull request
Mar 10, 2024
This got accidentally ignored in matplotlib#25147. We want D213 (matplotlib#17125, matplotlib#17193) https://matplotlib.org/devdocs/devel/document.html#quote-positions
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
Document how we currently already format docstring wrt quotes.
The mult-line case is already enforced via (pydocstyle D213).
The single line case (pydocstyle D200) is not enforced due to PyCQA/pydocstyle#453, but we still use it if possible.