-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: Updated Resampler.mean docstring to have its own docstring #48980
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
Conversation
I found that doc build error also occurs in previous commit(#48965). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
doc failure is related to a dependency
pandas/core/resample.py
Outdated
numeric_only : bool, default False | ||
Include only `float`, `int` or `boolean` data. | ||
|
||
.. versionadded:: 1.5.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why this versionadded?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@phofl In var
, std
method, numeric_only versionadded is written. So I thought mean
method also need versionadded. If it is wrong, I will fix it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
var and std did not support this prior to 1.5, but this function was consistent with the groupby op that already supported this before. So you can remove it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for comments. I removed it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
(As an aside, we should probably not auto-generate these methods for resample
like we did groupby
cc @rhshadrach)
Thanks @donghyyun |
…as-dev#48980) * DOC: Added mean function as method of Resampler and updated docstring * removed versionadded
Resampler.mean
#48803 which belongs toContributions welcome
milestoneBy default, the
Resampler.mean
docstring is inherited fromGroupBy.mean
. As a result, unsupported parameters 'engine' and 'engine_kwargs' were created in the API documentation.To do this, I defined the Mean function as a method of Resampler and wrote the docstring of the function itself.