-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
depr(python,rust!): Rename with_row_count
to with_row_index
#13494
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
breaking rust
Change that breaks backwards compatibility for the Rust crate
deprecation
Add a deprecation warning to outdated functionality
python
Related to Python Polars
rust
Related to Rust Polars
labels
Jan 6, 2024
stinodego
requested review from
ritchie46,
c-peters,
alexander-beedie,
MarcoGorelli and
orlp
as code owners
January 6, 2024 21:47
Seems fine by my. If code only renamed the methods it can be merged. |
stinodego
changed the title
depr(python,rust!): Rename
depr(python,rust!): Rename Jan 8, 2024
with_row_count
to with_row_number
with_row_count
to with_row_index
Based on the discussion in the linked issue and on Discord, let's go with |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
accepted
Ready for implementation
breaking rust
Change that breaks backwards compatibility for the Rust crate
deprecation
Add a deprecation warning to outdated functionality
python
Related to Python Polars
rust
Related to Rust Polars
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Ref #12420
The "row count" of a dataframe is its total number of rows. That's not what this method calculates. What it really does is add row numbers, as was already indicated by its default name "row_nr".
It also matches the SQL window function "ROW NUMBER" (as pointed out by Alex):
https://www.postgresql.org/docs/current/functions-window.html
This PR renames
with_row_count
towith_row_number
, and the default column name from "row_nr" to "row_number".Apparently there are a LOT of references to "row count" - e.g.
read_csv
parameters and others. I'm doing those separately as this PR was already unexpectedly large.EDIT: We decided to go with
with_row_index
instead. Partly to avoid confusion with the SQL function which starts at 1 (we start at 0).