Skip to content
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

Notes convert to Pandas-compat #12641

Merged
merged 25 commits into from
Jan 24, 2024
Merged

Notes convert to Pandas-compat #12641

merged 25 commits into from
Jan 24, 2024

Conversation

Touutae-lab
Copy link
Contributor

@Touutae-lab Touutae-lab commented Jan 30, 2023 •
edited by vyasr
Loading

Description

Closes #11460

image

I already change and test documentation in my localhost but some of it can't be change due

BUG

can't convert Note froms DataFrame.mode
image

convert to
image

Extension error (numpydoc.numpydoc):
Handler <function mangle_signature at 0x7fe25c23d630> for event 'autodoc-process-signature' threw an exception (exception: 
Error parsing See Also entry '.. pandas-compat::' in the docstring of mode in /home/touutae/miniconda3/envs/cudf_dev
/lib/python3.10/contextlib.py.)
make: *** [Makefile:20: html] Error 2

it only happened when edited DataFrame.mode

Originally posted by @Touutae-lab in #11460 (comment)

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@Touutae-lab Touutae-lab requested a review from a team as a code owner January 30, 2023 03:21
@rapids-bot
Copy link

rapids-bot bot commented Jan 30, 2023

Pull requests from external contributors require approval from a rapidsai organization member with write or admin permissions before CI can begin.

@github-actions github-actions bot added the Python Affects Python cuDF API. label Jan 30, 2023
@shwina
Copy link
Contributor

shwina commented Jan 30, 2023

Hi @Touutae-lab -- thanks for this PR!

Regarding the issue you're seeing with DataFrame.mode, I can reproduce the same problem. I was able to work around the issue by moving the .. pandas-compat section to after the Examples section.

Without this workaround, numpydoc/sphinx seems to want to parse the pandas-compat section as part of the See Also section. Perhaps @isVoid can guess why this is the case, or otherwise it seems like we have a bug in our implementation of the pandas-compat extension.

For this PR, can you make it a policy to always include pandas-compat as the final section when it is used in a docstring?

@Touutae-lab Touutae-lab requested a review from a team as a code owner January 31, 2023 06:28
@Touutae-lab Touutae-lab force-pushed the convert-notes branch 2 times, most recently from 2fa7fcd to 7d28378 Compare January 31, 2023 07:08
Touutae-lab
Touutae-lab commented Jan 31, 2023
View reviewed changes
Copy link
Contributor Author

@Touutae-lab Touutae-lab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overload _reduce method in DataFrameGroupBy, SeriesFrameGroupBy for Generate more relatable Pandascompat pages

@Touutae-lab
Copy link
Contributor Author

Touutae-lab commented Jan 31, 2023 •
edited
Loading

@shwina I already change what you have mention. can you check again. Thank for your time ! this is my first time contribute in project ❤️

wence-
wence- requested changes Jan 31, 2023
View reviewed changes
Copy link
Contributor

@wence- wence- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! A few minor comments where I think the note is not actually a pandas compat issue.

python/cudf/cudf/core/column/lists.py Outdated Show resolved Hide resolved
python/cudf/cudf/core/column/string.py Show resolved Hide resolved
python/cudf/cudf/core/dataframe.py Outdated Show resolved Hide resolved
python/cudf/cudf/core/dataframe.py Outdated Show resolved Hide resolved
python/cudf/cudf/core/dataframe.py Outdated Show resolved Hide resolved
python/cudf/cudf/core/frame.py Outdated Show resolved Hide resolved
python/cudf/cudf/core/groupby/groupby.py Outdated Show resolved Hide resolved
python/cudf/cudf/core/groupby/groupby.py Outdated Show resolved Hide resolved
python/cudf/cudf/core/groupby/groupby.py Outdated Show resolved Hide resolved
python/cudf/cudf/core/tools/datetimes.py Outdated Show resolved Hide resolved
@wence- wence- added doc Documentation non-breaking Non-breaking change labels Jan 31, 2023
@vyasr
Copy link
Contributor

vyasr commented Jan 31, 2023

@Touutae-lab could you retarget your changes to branch-23.04? We are no longer making changes for the 23.02 release. Thank you!

@Touutae-lab Touutae-lab changed the base branch from branch-23.02 to branch-23.04 February 1, 2023 02:06
@Touutae-lab
Copy link
Contributor Author

@vyasr of course ! i will keep update and merge. to keep updating with current main branch.

@Touutae-lab Touutae-lab closed this Feb 3, 2023
@Touutae-lab Touutae-lab reopened this Feb 3, 2023
@Touutae-lab Touutae-lab closed this Feb 3, 2023
@Touutae-lab Touutae-lab mentioned this pull request Feb 3, 2023
Closed
@Touutae-lab Touutae-lab deleted the convert-notes branch February 3, 2023 15:45
@vyasr
Copy link
Contributor

vyasr commented Feb 8, 2023

@Touutae-lab did you intend to close both this PR and and #12691 (and delete the branch)?

@Touutae-lab Touutae-lab restored the convert-notes branch February 9, 2023 09:39
@Touutae-lab
Copy link
Contributor Author

No, I'm trying to fix commit.

@vyasr vyasr changed the base branch from branch-23.12 to branch-24.04 January 22, 2024 23:06
@vyasr
Copy link
Contributor

vyasr commented Jan 22, 2024

@Touutae-lab I fixed a couple of things up for you here and I think this PR is good to go now. Sorry for the delay, and thank you for the contribution!

@vyasr
Copy link
Contributor

vyasr commented Jan 22, 2024

/ok to test

@vyasr vyasr dismissed stale reviews from galipremsagar and wence- January 22, 2024 23:16

stale

@github-actions github-actions bot added the libcudf Affects libcudf (C++/CUDA) code. label Jan 23, 2024
@vyasr
Copy link
Contributor

vyasr commented Jan 23, 2024

/ok to test

@github-actions github-actions bot removed the libcudf Affects libcudf (C++/CUDA) code. label Jan 23, 2024
@vyasr
Copy link
Contributor

vyasr commented Jan 23, 2024

/ok to test

@vyasr
Copy link
Contributor

vyasr commented Jan 23, 2024

/ok to test

@vyasr
Copy link
Contributor

vyasr commented Jan 23, 2024

/ok to test

@vyasr
Copy link
Contributor

vyasr commented Jan 24, 2024

/merge

2 similar comments
@vyasr
Copy link
Contributor

vyasr commented Jan 24, 2024

/merge

@AyodeAwe
Copy link
Contributor

/merge

@ajschmidt8 ajschmidt8 merged commit 60f04ce into rapidsai:branch-24.04 Jan 24, 2024
69 checks passed
PointKernel pushed a commit to PointKernel/cudf that referenced this pull request Jan 25, 2024
@Touutae-lab @PointKernel
Notes convert to Pandas-compat (rapidsai#12641)
bc130eb
@vyasr vyasr mentioned this pull request May 17, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vyasr vyasr vyasr approved these changes

@bdice bdice Awaiting requested review from bdice bdice was automatically assigned from rapidsai/cudf-cpp-codeowners

@wence- wence- Awaiting requested review from wence-

@galipremsagar galipremsagar Awaiting requested review from galipremsagar

Assignees

@Touutae-lab Touutae-lab

Labels
doc Documentation non-breaking Non-breaking change Python Affects Python cuDF API.
Projects
cuDF/Dask/Numba/UCX
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@Touutae-lab @shwina @vyasr @wence- @AyodeAwe @galipremsagar @ajschmidt8