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): Fix bullet points not rendering correctly in DataFrame.join docstring #16576

Merged
merged 2 commits into from
May 29, 2024
Merged

docs(python): Fix bullet points not rendering correctly in DataFrame.join docstring #16576

merged 2 commits into from
May 29, 2024

Conversation

MarcoGorelli
Copy link
Collaborator

@MarcoGorelli MarcoGorelli commented May 29, 2024 •
edited
Loading

once again, fixing up docstring bullet points which don't render properly 😄 check the "coalesce" arg description in https://docs.pola.rs/py-polars/html/reference/dataframe/api/polars.DataFrame.join.html

bonus drive-bys:

  • some ergonomic syntax
  • Series.cum_count was left out of the docs

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels May 29, 2024
@MarcoGorelli MarcoGorelli marked this pull request as ready for review May 29, 2024 13:25
stinodego
stinodego approved these changes May 29, 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.

Thanks 👌

@stinodego stinodego changed the title docs(python): fix coalesce bullet points not rendering docs(python): Fix bullet points not rendering in DataFrame.join docstring May 29, 2024
@stinodego stinodego changed the title docs(python): Fix bullet points not rendering in DataFrame.join docstring docs(python): Fix bullet points not rendering correctly in DataFrame.join docstring May 29, 2024
@alexander-beedie
Copy link
Collaborator

alexander-beedie commented May 29, 2024 •
edited
Loading

While you're in those methods I spotted another one 😁

This is currently not supported the streaming engine.

...should be:

This is currently not supported by the streaming engine.

@stinodego stinodego merged commit ef1c0c8 into pola-rs:main May 29, 2024
16 checks passed
Wouittone pushed a commit to Wouittone/polars that referenced this pull request Jun 22, 2024
@MarcoGorelli @stinodego @Wouittone
docs(python): Fix bullet points not rendering correctly in `DataFrame…
389195a 
….join` docstring (pola-rs#16576)

Co-authored-by: Stijn de Gooijer <[email protected]>
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

@reswqa reswqa Awaiting requested review from reswqa reswqa 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
@MarcoGorelli @alexander-beedie @stinodego