DOC: Add details of dropna in DataFrame.pivot_table #61184
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added test :callable:`test_pivot_table_index_and_column_keys_with_nan` to test that null index/column keys are kept when `dropna=False`, and removed when `dropna=True`.
- Updated docs for `dropna` parameter in :callable:`pivot_table`.
|
Which |
- Replaced `np.NaN` with `np.nan` to pass failing tests on CI build.
- Added comma and period to `dropna` parameter in :callable:`pivot_table` to pass docstring validation hook in CI build.
rhshadrach
requested changes
Mar 28, 2025
pandas/core/reshape/pivot.py
Outdated
Comment on lines
105
to
107
| - rows with a NaN value in any column will be omitted before computing margins, | ||
| - index/column keys containing NA values will be dropped (see ``dropna`` | ||
| parameter in ``pandas.DataFrame.groupby``). |
There was a problem hiding this comment.
You'll also need to update the entry in shared_docs within pandas.core.frame.
There was a problem hiding this comment.
Can you use an NA value instead of a NaN value. Also link to the groupby via :meth:`DataFrame.groupby` instead of pandas.DataFrame.groupby.
There was a problem hiding this comment.
It's :meth: and not :method: for sphinx.
rhshadrach
added
Docs
Missing-data
- Updated reference link to `pandas.DataFrame.groupby` with :method: syntax in the :callable:`pivot_table` param `dropna` docstring.
- Replaced "NaN" with "NA" per request from @rhshadrach in comment.
- Updated value of :attr:`DataFrame._shared_docs["pivot_table"]` to include updated docstring from `pandas.core.reshape.pivot.pivot_table`.
rhshadrach
requested changes
Mar 28, 2025
rhshadrach
reviewed
Mar 28, 2025
- Updated spelling of :method: to :meth: per comment feedback.
- Updated shared docs replacing :method: with :meth: per comment feedback.
- Removed docstring for `test_pivot_table_index_and_column_keys_with_nan` per comment feedback.
- Renamed `actual` -> `result` per comment feedback.
- Removed type hints for `test_pivot_table_index_and_column_keys_with_nan` per comment feedback.
- Removed data manipulations from `expected` to prevent dependencies on other pandas methods.
- Added comment with GitHub issue reference number.
- Updated _shared_docs["pivot_table"] to match docstring in pandas/core/reshape/pivot.py. modified: pandas/core/reshape/pivot.py - Updated `dropna` param docstring in `pivot_table` so the dashes convert to a bulleted list.
|
Think I figured it out in 1a82d2a. |
- Updated dropna param description in `_shared_docs["pivot_table"]` to use bulleted list similar to `parse_dates` param description in `pandas.io.parsers.readers._doc_read_csv_and_table`. modified: pandas/core/reshape/pivot.py - Updated docstring for `dropna` param in :func:`pivot_table` to use bulleted list similar to `parse_dates` param description in `pandas.io.parsers.readers._doc_read_csv_and_table`.
- Updated `_shared_docs["pivot_table"]` value per comments. modified: pandas/core/reshape/pivot.py - Updated `dropna` param docstring in :func:`pivot_table` per comments.
|
@rhshadrach ready for review |
rhshadrach
changed the title
|
Thanks @it176131 - nice work! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
pivot_tabledrops rows and columns despite values being non-NaN#61113doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.