Skip to content

DOC: Docs for groupby.transform() should mention that function parameter can be a string in transform #49961

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

Closed
1 task done
ramvikrams opened this issue Nov 29, 2022 · 6 comments · Fixed by #50002
Closed
1 task done

Comments

@ramvikrams
Copy link
Contributor

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.DataFrameGroupBy.transform.html
https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.core.groupby.SeriesGroupBy.transform.html

Documentation problem

the current doc does not indicate that a string is accepted as a function parameter transform in groupby.transform().

Suggested fix for documentation

docs for transform need to indicate that the function parameter in groupby.transform() can be a string function name, and that an example should be included.

@ramvikrams ramvikrams added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Nov 29, 2022
@ramvikrams ramvikrams changed the title DOC: DOC: Docs for groupby.trsnform() should mention that function parameter can be a string Nov 29, 2022
@ramvikrams ramvikrams changed the title DOC: Docs for groupby.trsnform() should mention that function parameter can be a string DOC: Docs for groupby.trsnform() should mention that function parameter can be a string in transform Nov 29, 2022
@Dr-Irv Dr-Irv added Bug Groupby good first issue and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Nov 29, 2022
@Dr-Irv Dr-Irv changed the title DOC: Docs for groupby.trsnform() should mention that function parameter can be a string in transform DOC: Docs for groupby.transform() should mention that function parameter can be a string in transform Nov 29, 2022
@PranshuKaushal
Copy link

I would like to work on this. Assign me this issue please.

@ramvikrams
Copy link
Contributor Author

ramvikrams commented Nov 30, 2022

I would like to work on this. Assign me this issue please.

you are free to create a pr, anyone who's pr will be submitted first will be considered

@yuvanist
Copy link
Contributor

yuvanist commented Dec 1, 2022

take

@seanjedi
Copy link
Contributor

seanjedi commented Dec 1, 2022

@ramvikrams I will take your word on this comment: #49961 (comment)
I created a PR here that I believe should fix this in the docs: #50002

@ramvikrams
Copy link
Contributor Author

ramvikrams commented Dec 2, 2022

@ramvikrams I will take your word on this comment: #49961 (comment) I created a PR here that I believe should fix this in the docs: #50002

thanks fot your commit, can please also add an example for that, and I feel it should be like
It accepts a string, can also accept a Numba JIT function

@seanjedi
Copy link
Contributor

seanjedi commented Dec 2, 2022

@ramvikrams I added this PR here for the comment you made here: #49961 (comment)
New PR: #50029

Please review and approve if this is what you meant

@yuvanist yuvanist removed their assignment Dec 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants