Improve docstrings for most commonly used classes and configs #1630
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.
Overview
This PR improves the docstrings for the most commonly used classes and configs. Most config docstrings now have a link to their corresponding non-config class.
Checklist
needs-backport
label if PR is bug fix that applies to previous minor releaseNotes
While working on this PR, I learned that
can be shortened to
This made adding cross-reference to docstrings a lot cleaner.
Testing Instructions
Check if the build docs look fine.
Part of #1505