DOC: add pivot_table note to dropna doc #47808
Conversation
|
Thanks for the pull request @Mehgarg The pandas documentation is generated automatically from markdown files and docstring (documentation in the code). We never edit the final html files directly. I think the changes you want to implement should be done to this docstring instead: https://github.com/pandas-dev/pandas/blob/main/pandas/core/frame.py#L6427 Can you revert this html file you're creating and edit the docstring please? Let me know if you need help |
datapythonista
changed the title
pandas/core/frame.py
Outdated
| @@ -6455,7 +6455,7 @@ def dropna( | |||
| subset : column label or sequence of labels, optional | |||
| Labels along other axis to consider, e.g. if you are dropping rows | |||
| these would be a list of columns to include. | |||
| inplace : bool, default False | |||
| inplace : bool, default False | |||
pandas/core/frame.py
Outdated
| Notes | ||
| -------- | ||
| Setting dropna to true will elimate rows containing any missing data | ||
| from the pivot_table. |
There was a problem hiding this comment.
This doesn't seem to make a lot of sense. This method has nothing to do with pivot_table, and dropna is not a parameter, can't be set to anything. Maybe you may want to close this PR, try to understand better what you want to do, and start again?
| @@ -0,0 +1,415 @@ | |||
|
|
|||
There was a problem hiding this comment.
You should revert the changes to this whole file (delete it).
|
Is the failed check expected behavior or do I need to fix something? |
pandas/core/frame.py
Outdated
| @@ -10045,7 +10047,7 @@ def merge( | |||
| suffixes: Suffixes = ("_x", "_y"), | |||
| copy: bool = True, | |||
| indicator: bool = False, | |||
| validate: str | None = None, | |||
| validate: str | None = None, | |||
There was a problem hiding this comment.
Can you please revert this?
There was a problem hiding this comment.
This is pending and making the CI red
pandas/core/frame.py
Outdated
| @@ -8564,7 +8564,9 @@ def pivot(self, index=None, columns=None, values=None) -> DataFrame: | |||
| margins : bool, default False | |||
| Add all row / columns (e.g. for subtotal / grand totals). | |||
| dropna : bool, default True | |||
| Do not include columns whose entries are all NaN. | |||
| Do not include columns whose entries are all NaN. If true: | |||
There was a problem hiding this comment.
True refers to Python True value, we usually use it with capital T. Also, please avoid the colon, as it's inconsistent with the rest of the docs, and personally I think make things harder to read in this case.
Other than those small formatting things, I think your description is clear now, thanks for thr update.
There was a problem hiding this comment.
made the changes, thanks for the help.
|
Thanks @Mehgarg |
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.