POC: docstring inheritance #31110
Closed
POC: docstring inheritance #31110
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
|
Looks nice though I am actually -1 on inheriting docstrings compared to simplifying the existing Appender / Substitution decorators. I suppose my main argument is that not everything really can be inherited (ex: we sometimes inherit but change signature or semantics) so would end up having to revert back to Appender / Substitution anyway in some cases |
|
Closing to clear the queue |
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.
Proof of concept for automatically inheriting docstrings, so we dont have to use
@Appender(parent_class.method.__doc__)quite so much.This doesnt handle
@Substitution. If we can make that work for the common case where we're just putting in the class name, we could get a lot less verbose.xref #31095, #31060.