Skip to content

DOC: improve MultiIndex.is_monotonic_increasing/decreasing docstrings#65154

Merged
mroeschke merged 1 commit into
pandas-dev:mainfrom
jbrockmendel:doc-32179
Apr 10, 2026
Merged

DOC: improve MultiIndex.is_monotonic_increasing/decreasing docstrings#65154
mroeschke merged 1 commit into
pandas-dev:mainfrom
jbrockmendel:doc-32179

Conversation

@jbrockmendel

Copy link
Copy Markdown
Member

Summary

  • Expands the minimal one-line docstrings for MultiIndex.is_monotonic_increasing and MultiIndex.is_monotonic_decreasing to include a description of how monotonicity is evaluated for a MultiIndex (lexicographic tuple comparison with tie-breaking by subsequent levels), Returns, See Also, and Examples sections.

closes #32179

Test plan

  • Verified all docstring examples produce correct output
  • Existing monotonic tests pass (pytest pandas/tests/indexes/multi/ -k monotonic)
  • Pre-commit hooks pass

🤖 Generated with Claude Code

Expand the minimal one-line docstrings to include a description of
how monotonicity is evaluated for MultiIndex (lexicographic tuple
comparison with tie-breaking), Returns, See Also, and Examples sections.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@mroeschke mroeschke added this to the 3.1 milestone Apr 10, 2026
@mroeschke mroeschke added the Docs label Apr 10, 2026
@mroeschke mroeschke merged commit 4529644 into pandas-dev:main Apr 10, 2026
45 checks passed
@mroeschke

Copy link
Copy Markdown
Member

Thanks @jbrockmendel

@jbrockmendel jbrockmendel deleted the doc-32179 branch April 10, 2026 21:08
Sharl0tteIsTaken added a commit to Sharl0tteIsTaken/pandas that referenced this pull request Apr 12, 2026
…-comparison

* upstream/main:
  PERF: use lookup instead of hash_inner_join for merge with unique right keys (pandas-dev#64691)
  BUG : update `SeriesGroupBy.ohlc()` to honor `as_index=False` (pandas-dev#65141)
  PERF: Use DataFrame-level reductions in DataFrame.agg with list of funcs (pandas-dev#65031)
  DOC: document required external libraries in read_* I/O docstrings (pandas-dev#65143)
  DOC: improve MultiIndex.is_monotonic_increasing/decreasing docstrings (pandas-dev#65154)
  BUG: Raise ValueError for non-boolean numeric_only in DataFrame/Series reductions (GH#53098) (pandas-dev#65131)
  BUG: Timedelta.round() raises ZeroDivisionError when internal unit is 's' and target frequency is sub-second (pandas-dev#64836)
  ENH: Add replace method to Index (closes pandas-dev#19495) (pandas-dev#65099)
  PERF: improve StringArray.isna (pandas-dev#57733)
  BUG: read parquet files with older pytz (DEP: keep lower pytz minimum version) (pandas-dev#65133)
  DEPR: deprecate dates-with-datetime64 in _maybe_downcast_for_indexing (pandas-dev#64871)
  DOC: note that DataFrame.values is not writeable (pandas-dev#65142)
  CLN: Update groupby observed defaults (pandas-dev#65148)
  PERF: avoid materializing values[indexer] in Block.setitem (pandas-dev#64251)
  DOC: update GroupBy.sum/min/max See Also sections (pandas-dev#65144)
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.

MultiIndex.is_monotonic_increasing

2 participants