DOC: sort has no effect on filters #51825
Conversation
|
In the API docs for DataFrame.groupby and Series.groupby the fact that |
pandas/core/shared_docs.py
Outdated
| This argument has no effect on some aggregating functions, such as | ||
| :ref:`head, tail <basics.aggregate>` and ``nth[:]``. |
There was a problem hiding this comment.
it might be good to mention "filtrations" rather than "some aggregating functions", and link to the "filtrations" section introduced in https://github.com/pandas-dev/pandas/pull/51704/files?
as yes, it might be good to note it in as_index too
There was a problem hiding this comment.
Thanks, I did as you suggested. I think ci failures aren't related to my changes.
There was a problem hiding this comment.
thanks!
not sure, it's showing
/home/runner/work/pandas/pandas/pandas/core/frame.py:docstring of pandas.core.frame.DataFrame.groupby:210: WARNING: Duplicate explicit target name: "groupby user guide".
/home/runner/work/pandas/pandas/pandas/core/frame.py:docstring of pandas.core.frame.DataFrame.groupby:210: WARNING: Duplicate explicit target name: "groupby user guide".
/home/runner/work/pandas/pandas/pandas/core/series.py:docstring of pandas.core.series.Series.groupby:188: WARNING: Duplicate explicit target name: "groupby user guide".
/home/runner/work/pandas/pandas/pandas/core/series.py:docstring of pandas.core.series.Series.groupby:188: WARNING: Duplicate explicit target name: "groupby user guide".
which might be due to the link you wrote?
There was a problem hiding this comment.
Thank you for the comment. I agree, the warnings are related to my changes. There are two different links in one doctsring with the same name, which causes the problem. I changed the name of my link.
It’s interesting, while I run validation
python scripts/validate_docstrings.py pandas.core.groupby.DataFrameGroupBy and
python scripts/validate_docstrings.py pandas.core.groupby.SeriesGroupBy there were no warnings.
After validation, I cleaned and built new documentation locally. Then I just checked html, my links worked right. My mistake, I should check warnings raised by the build.
pandas/core/shared_docs.py
Outdated
| @@ -114,11 +114,17 @@ | |||
| as_index : bool, default True | |||
| For aggregated output, return object with group labels as the | |||
There was a problem hiding this comment.
With your addition (if we add in transformations, see below), I think "For aggregated output," can be removed. But I'm also okay with it staying as well.
There was a problem hiding this comment.
I removed "For aggregated output,". With my addition, there is no need to write this.
pandas/core/shared_docs.py
Outdated
| effectively "SQL-style" grouped output. This argument has no effect | ||
| on filtrations (see the `filtration user guide | ||
| <https://pandas.pydata.org/docs/dev/user_guide/groupby.html#filtration>`_), | ||
| such as ``head()``, ``tail()`` and ``nth()``. |
There was a problem hiding this comment.
Can you add in transformations here as well?
I would describe it as "filtrations in the user guide" rather than "filteration user guide"; what do you think?
There was a problem hiding this comment.
I agree, "filtrations in the user guide" sounds more correct and more clear.
pandas/core/shared_docs.py
Outdated
| This argument has no effect on filtrations (see the `filtration user guide | ||
| <https://pandas.pydata.org/docs/dev/user_guide/groupby.html#filtration>`_), | ||
| such as ``head()``, ``tail()`` and ``nth()``. |
|
@MarcoGorelli - any further comments? |
|
Thanks @MarcoGorelli and @rhshadrach for helping me with this pr. |
Updated docs for
DataFrame.groupbyandSeries.groupby, pointed out that the parameter thesortparameter has no effect on filters.