Skip to content

DOC: pandas/pandas/core/window/ewm.py #34867

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.

Sign up for GitHub

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

Jump to bottom
Closed
db-baron opened this issue Jun 18, 2020 · 5 comments · Fixed by #34910
Closed

DOC: pandas/pandas/core/window/ewm.py #34867

db-baron opened this issue Jun 18, 2020 · 5 comments · Fixed by #34910
Assignees
@KrishnaSai2020
Labels
Docs good first issue Window rolling, ewma, expanding
Milestone
1.1

Comments

@db-baron
Copy link

Location of the documentation

Docstring for class EWM(_Rolling) in ewm.py.

Documentation problem

The purposes of the EWM class is unclear because there's no documentation on what 'ewm' is abbreviating. One reason this is confusing is that ewm can easily be interpreted as either "exponentially weighted mean" or "exponentially weighted moving". The EWM class docstring actually muddies the water further by stating that the class provides "exponential weighted (EW) functions".

Suggested fix for documentation

If it's absolutely necessary to use an abbreviation like ewm then the docstring needs to clearly state what it's abbreviating.
@db-baron db-baron added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jun 18, 2020
@MarcoGorelli
Copy link
Member

Thanks @db-baron for the report - are you interested in submitting a pull request?

@MarcoGorelli MarcoGorelli added good first issue and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Jun 19, 2020
@KrishnaSai2020
Copy link
Contributor

take

This was referenced Jun 20, 2020
Closed
Merged
@jreback
Copy link
Contributor

jreback commented Jun 20, 2020

closing in favor of #34910

@jreback jreback closed this as completed Jun 20, 2020
@charlesdong1991
Copy link
Member

ehh? this is the issue, not PR? @jreback

@MarcoGorelli
Copy link
Member

Reopening as I'm pretty sure Jeff meant to close #34901 instead :)

@MarcoGorelli MarcoGorelli reopened this Jun 20, 2020
@jreback jreback added this to the 1.1 milestone Jun 20, 2020
@jreback jreback added the Window rolling, ewma, expanding label Jun 20, 2020
jreback pushed a commit that referenced this issue Jun 20, 2020
@KrishnaSai2020 @charlesdong1991
DOC: explain EWM (#34910)
8eb1048 
* fixed issue #34867

* pep8:  line too long

* Update pandas/core/generic.py

Co-authored-by: Kaiqi Dong <[email protected]>

* fixed issue #34867

* fixed issue #34867

* fixed pep8 issue

* renamed exponentialmoving back to ewm.py

* pep 8 issues

* pep 8 issues

Co-authored-by: KrishnaSai2020 <[email protected]>
Co-authored-by: Kaiqi Dong <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@KrishnaSai2020 KrishnaSai2020

Labels
Docs good first issue Window rolling, ewma, expanding
Projects
None yet
Milestone
1.1
Development

Successfully merging a pull request may close this issue.

DOC: explain EWM
DOC: explain EWM
5 participants
@jreback @charlesdong1991 @db-baron @MarcoGorelli @KrishnaSai2020