-
Notifications
You must be signed in to change notification settings - Fork 645
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
BUG: docs extension: unspecified subclass documentation causes superclass documentation to be overridden #7113
Comments
update: seems like a better solution is to have the |
To clarify the behaviors with a
not sure about how to solve these; will come back to this soon. |
the desired behaviors in both scenarios:
|
I guess the fix for (2) will change the behavior of (1) so that inheriting from a superclass is not necessary. That makes sense to me. |
NOTE when testing this, we have to test both methods and properties, which we override by replacing the original property. |
e.g. if I add custom documentation for
DataFrameGroupBy.mean
but not forSeriesGroupBy.mean
, thenSeriesGroupBy.mean
andDataFrameGroupby.mean
are the same object, and we override that object's__doc__
with the pandas docstring when we defineSeriesGroupBy.mean
.one solution: explicitly define methods like
SeriesGroupBy.mean
so that they become distinct from the superclass methods.The text was updated successfully, but these errors were encountered: