Skip to content

DOC: Inline docstring for GroupByPositionalSelector#63944

Merged
mroeschke merged 1 commit intopandas-dev:mainfrom
littleKitchen:doc/inline-docstring-groupby-indexing
Jan 29, 2026
Merged

DOC: Inline docstring for GroupByPositionalSelector#63944
mroeschke merged 1 commit intopandas-dev:mainfrom
littleKitchen:doc/inline-docstring-groupby-indexing

Conversation

@littleKitchen
Copy link
Contributor

Part of #62437

Summary

This PR removes the @doc decorator from GroupByPositionalSelector in pandas/core/groupby/indexing.py and inlines the docstring from GroupByIndexingMixin._positional_selector directly into the class.

Changes

  • Removed @doc(GroupByIndexingMixin._positional_selector) decorator
  • Added the docstring as an inline class docstring
  • Removed the now-unused doc import from pandas.util._decorators

This is a straightforward copy of the docstring with no modifications needed since the class directly implements the _positional_selector functionality.

Part of pandas-dev#62437

This removes the @doc decorator from GroupByPositionalSelector and
inlines the docstring from GroupByIndexingMixin._positional_selector
directly into the class.

Also removes the now-unused doc import from pandas.util._decorators.
@mroeschke mroeschke added the Docs label Jan 29, 2026
@mroeschke mroeschke added this to the 3.1 milestone Jan 29, 2026
@mroeschke mroeschke merged commit c7d37af into pandas-dev:main Jan 29, 2026
46 of 47 checks passed
@mroeschke
Copy link
Member

Thanks @littleKitchen

Sharl0tteIsTaken added a commit to Sharl0tteIsTaken/pandas that referenced this pull request Jan 30, 2026
…-comparison

* upstream/main: (29 commits)
  DOC: Inline docstrings in pandas/io/excel/_odfreader.py (GH#62437) (pandas-dev#63943)
  DOC: Inline docstring for GroupByPositionalSelector (pandas-dev#63944)
  DOC: Fix PR02,SA01 for pandas.tseries.offsets.CDay (pandas-dev#63929)
  DOC: Fix typo in text data user guide (pandas-dev#63930)
  DOC: Fix PR02,SA01 for pandas.tseries.offsets.BDay (pandas-dev#63928)
  DOC: Fix GL08 for pandas.tseries.offsets.SemiMonthEnd.is_on_offset (pandas-dev#63926)
  DOC: Fix GL08 for pandas.tseries.offsets.Week.is_on_offset (pandas-dev#63927)
  DOC: Fix GL08 for pandas.tseries.offsets.Easter.is_on_offset (pandas-dev#63922)
  DOC: Fix GL08 for pandas.tseries.offsets.FY5253Quarter.rule_code (pandas-dev#63923)
  DOC: Fix GL08 for pandas.tseries.offsets.SemiMonthBegin.is_on_offset (pandas-dev#63924)
  BUG: still use object dtype for pyarrow-backed IO methods with infer_strings disabled (pandas-dev#63900)
  BUG: Correct length_of_indexer for range objects (pandas-dev#63872)
  DOC: Add guide links to relevant API docs (pandas-dev#62650)
  BUG: fix CoW handling of DataFrame(index/series) constructor (pandas-dev#63908)
  TST: mark plotting backend tests as single-threaded (pandas-dev#63911)
  DOC: Fix PR02 for pandas.tseries.offsets.CBMonthBegin (pandas-dev#63878)
  TST: Remove Windows ARROW_TIMEZONE_DATABASE xfails for PyArrow>=22 (pandas-dev#63905)
  CI: Simplify docs build with workflow_dispatch (pandas-dev#63852)
  DOC: Add User Guide links to GroupBy aggregate, transform, and apply methods (pandas-dev#63837)
  ENH: Raise TypeError when not np.busdaycalendar is passed to custom subclasses (pandas-dev#63854)
  ...
Sharl0tteIsTaken added a commit to Sharl0tteIsTaken/pandas that referenced this pull request Jan 30, 2026
…h-origin

* upstream/main:
  DOC: Inline docstrings in pandas/io/excel/_odfreader.py (GH#62437) (pandas-dev#63943)
  DOC: Inline docstring for GroupByPositionalSelector (pandas-dev#63944)
  DOC: Fix PR02,SA01 for pandas.tseries.offsets.CDay (pandas-dev#63929)
  DOC: Fix typo in text data user guide (pandas-dev#63930)
  DOC: Fix PR02,SA01 for pandas.tseries.offsets.BDay (pandas-dev#63928)
  DOC: Fix GL08 for pandas.tseries.offsets.SemiMonthEnd.is_on_offset (pandas-dev#63926)
  DOC: Fix GL08 for pandas.tseries.offsets.Week.is_on_offset (pandas-dev#63927)
  DOC: Fix GL08 for pandas.tseries.offsets.Easter.is_on_offset (pandas-dev#63922)
  DOC: Fix GL08 for pandas.tseries.offsets.FY5253Quarter.rule_code (pandas-dev#63923)
  DOC: Fix GL08 for pandas.tseries.offsets.SemiMonthBegin.is_on_offset (pandas-dev#63924)
  BUG: still use object dtype for pyarrow-backed IO methods with infer_strings disabled (pandas-dev#63900)
  BUG: Correct length_of_indexer for range objects (pandas-dev#63872)
  DOC: Add guide links to relevant API docs (pandas-dev#62650)
  BUG: fix CoW handling of DataFrame(index/series) constructor (pandas-dev#63908)
  TST: mark plotting backend tests as single-threaded (pandas-dev#63911)
  DOC: Fix PR02 for pandas.tseries.offsets.CBMonthBegin (pandas-dev#63878)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants