Document docstring requirements with examples #6081
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 m
8000
ore about bidirectional Unicode characters
DOC-5 Establish and document internal module docstring requirements
And add them to the contribution guidelines DOC-4 Establish and document public module docstring requirements
And add them to the contribution guidelines |
Contributor
Author
|
Please review |
adriangb
approved these changes
Jun 11, 2023
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.
Updates contribution guide with details on docstring requirements.
Change Summary
ignore_init_summary: trueandmerge_init_into_class: trueconfiguration. This will enable correct documentation of class vs instance attributes -- instance attributes should be documented in__init__, and mkdocstrings will pull this into the class documentation. See https://mkdocstrings.github.io/python/usage/configuration/docstrings/#merge_init_into_class for background.The
merge_init_into_class: trueconfiguration change does not affect API documentation currently, but enables documenting instance attributes correctly in future PRs.Related issue number
Closes DOC-4
Closes DOC-5
Checklist
changes/<pull request or issue id>-<github username>.mdfile added describing change(see changes/README.md for details)
Selected Reviewer: @adriangb