Cleanup backend_tools docstrings, and minor refactorings. #19752
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
Properties already show up with their docstrings in the generated docs, so no need to list them in a separate API section (also note that the document type of the figure attribute was wrong).
jklymak
approved these changes
Mar 21, 2021
timhoffm
approved these changes
Mar 23, 2021
There was a problem hiding this comment.
I'd still like to have an attribute summary (and a method summary), but that's more a matter of autosummary tuning/extension. Did I mention that I like the way Qt docs organizes these things https://doc.qt.io/qt-5/qabstractbutton.html?
I agree however, that it's not reasonable to duplicate the attribute docs.
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.
Properties already show up with their docstrings in the generated docs,
so no need to list them in a separate API section (also note that the
document type of the figure attribute was wrong).
PR Summary
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand 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).