Skip to content

docs: Clarify DataFrame.sort returns new frame#27442

Closed
uurl wants to merge 1 commit intopola-rs:mainfrom
uurl:docs/dataframe-sort-new-frame-17636
Closed

docs: Clarify DataFrame.sort returns new frame#27442
uurl wants to merge 1 commit intopola-rs:mainfrom
uurl:docs/dataframe-sort-new-frame-17636

Conversation

@uurl
Copy link
Copy Markdown
Contributor

@uurl uurl commented Apr 29, 2026

Fixes #17636.

Clarifies the DataFrame.sort docstring to state that it returns a new sorted DataFrame, rather than implying in-place mutation.

  • I used AI to help identify the affected docstring and draft the PR description.
  • I confirm that I have reviewed the change myself, and I believe it is relevant and correct.

@github-actions github-actions Bot added documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars labels Apr 29, 2026
@orlp
Copy link
Copy Markdown
Member

orlp commented Apr 29, 2026

Hi, I've noticed a lot of small docs PRs coming in. I appreciate the effort but I'd suggest sticking to issues which have the Accepted label to reduce wasted (review) effort.

@orlp orlp closed this Apr 29, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 29, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.14%. Comparing base (005b111) to head (5de058e).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #27442      +/-   ##
==========================================
- Coverage   81.62%   80.14%   -1.48%     
==========================================
  Files        1836     1836              
  Lines      254252   254252              
  Branches     3180     3180              
==========================================
- Hits       207527   203767    -3760     
- Misses      45901    49661    +3760     
  Partials      824      824              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@uurl uurl deleted the docs/dataframe-sort-new-frame-17636 branch April 29, 2026 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Description of sort method is ambiguous

2 participants