Clarify inherited attribute docstrings#975
Open
bharatbushan03 wants to merge 1 commit into
Open
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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
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.
Summary
Resolves #925
This PR standardizes the documentation format for child classes that inherit attributes from parent classes.
Instead of duplicating the entire attribute description (which creates a maintenance burden) or using overly vague shortcuts (like "See parent"), this change implements an explicit, maintainable reference style:
[Attribute]: Inherited from :class:[ParentClass].Changes
:class:cross-references pointing back to the parent class for all inherited attributes.Rationale
Copy-pasting docstrings across multiple child classes scales poorly when arguments grow or change. By explicitly referencing the parent class, we keep the codebase maintainable while ensuring automated documentation tools (like Sphinx) can still track the inheritance seamlessly.
Verification Results