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.

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

docs(python): Add a couple of docstring examples to Series methods #13244

Merged
merged 1 commit into from
Dec 26, 2023

Conversation

Copy link
Collaborator

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

Nice! Only super minor comment would be to include an example for log with a different base, but not a blocker (and can be done later!)

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.

Looks great, thanks!

For future examples, you may want to include some values that are of particular interest to that method, like you've done for abs (include some negative values). For example, sqrt could've been 1, 2, and -9 or something. Or log could include math.e and 10 and showcase the default and base=10.

In any case, good job and this can be merged!

@stinodego stinodego changed the title added a couple examples to series docs docs(python): Add a couple of docstring examples to Series methods Dec 26, 2023
@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels Dec 26, 2023
@stinodego stinodego merged commit a34a4f0 into pola-rs:main Dec 26, 2023
16 checks passed
@r-brink r-brink deleted the new-docs branch January 9, 2024 11:14
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants