Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs(python): use proper argument names in the code blocks of api.rst #13866

Merged
merged 2 commits into from
Jan 20, 2024
Merged

docs(python): use proper argument names in the code blocks of api.rst #13866

merged 2 commits into from
Jan 20, 2024

Conversation

kstoneriv3
Copy link
Contributor

@kstoneriv3 kstoneriv3 commented Jan 19, 2024 •
edited
Loading

Thanks for developing such an amazing library! Just fixing argument names to ones for polars rather than ones for pandas. The original code blocks did work by just copy-and-pasting but now they should.

@kstoneriv3 kstoneriv3 marked this pull request as ready for review January 19, 2024 23:48
@kstoneriv3 kstoneriv3 changed the title Update argument names in api.rst docs(python): Update argument names in api.rst Jan 19, 2024
stinodego
stinodego approved these changes Jan 19, 2024
View reviewed changes
Copy link
Member

@stinodego stinodego left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, thanks for making a PR!

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels Jan 19, 2024
@kstoneriv3 kstoneriv3 changed the title docs(python): Update argument names in api.rst docs(python): use proper argument names in the code blocks of api.rst Jan 19, 2024
@stinodego stinodego merged commit 7c13fa4 into pola-rs:main Jan 20, 2024
18 checks passed
@alexander-beedie
Copy link
Collaborator

alexander-beedie commented Jan 20, 2024 •
edited
Loading

Thanks! FYI: columns actually used to be our parameter name too (a long time ago in a galaxy far far away) :)

@kstoneriv3 kstoneriv3 deleted the kstoneriv3-patch-1 branch January 21, 2024 19:12
r-brink pushed a commit to r-brink/polars that referenced this pull request Jan 24, 2024
@kstoneriv3 @r-brink
docs(python): use proper argument names in the code blocks of api.rst (…
0912cde 
…pola-rs#13866)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stinodego stinodego stinodego approved these changes

@ritchie46 ritchie46 Awaiting requested review from ritchie46 ritchie46 is a code owner

@c-peters c-peters Awaiting requested review from c-peters c-peters is a code owner

@alexander-beedie alexander-beedie Awaiting requested review from alexander-beedie alexander-beedie is a code owner

@MarcoGorelli MarcoGorelli Awaiting requested review from MarcoGorelli MarcoGorelli is a code owner

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation python Related to Python Polars
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kstoneriv3 @alexander-beedie @stinodego