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: Pyarrow example docstrings for Expr and stable v1 API #1218

Merged
merged 6 commits into from
Oct 20, 2024

Conversation

CarloLepelaars
Copy link
Contributor

@CarloLepelaars CarloLepelaars commented Oct 18, 2024

What type of PR is this? (check all applicable)

  • 📝 Documentation

Related issues

Checklist

  • Code follows style guide (ruff)
  • Tests added
  • Documented the changes

If you have comments or can explain your changes, please do so below.

PyArrow docstring examples for narwhals/expr.py and narwhals/stable/v1/__init__.py.

I know #1000 mentions to do 4 functions in 1 PR, but was in a good flow so did the full expr.py. 😊 I think it's still within reason for review.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 18, 2024
Copy link
Contributor

@EdAbati EdAbati left a comment

Choose a reason for hiding this comment

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

Thank you for the effort! :)

It all looks great to me, I just suggested to add a couple of comments for consistency with polars.

Tests being green makes confindent to approve, but because of the size of the PR, I'd wait a bit for another review before merging (I may have missed something)

narwhals/expr.py Outdated Show resolved Hide resolved
narwhals/expr.py Outdated Show resolved Hide resolved
narwhals/expr.py Outdated Show resolved Hide resolved
CarloLepelaars and others added 3 commits October 19, 2024 17:51
Co-authored-by: Edoardo Abati <29585319+EdAbati@users.noreply.github.com>
Co-authored-by: Edoardo Abati <29585319+EdAbati@users.noreply.github.com>
Co-authored-by: Edoardo Abati <29585319+EdAbati@users.noreply.github.com>
Copy link
Contributor

@EdAbati EdAbati left a comment

Choose a reason for hiding this comment

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

Nice! Thanks again 👌

Copy link
Member

@FBruzzesi FBruzzesi left a comment

Choose a reason for hiding this comment

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

Wow crazy effort! Thanks a ton for this one! I skimmed through it without noticing anything wrong, and also trust the doctests 😂

Copy link
Member

@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.

thanks @CarloLepelaars , and thanks @EdAbati for reviewing!

@MarcoGorelli MarcoGorelli merged commit 6af79b4 into narwhals-dev:main Oct 20, 2024
25 checks passed
@CarloLepelaars CarloLepelaars deleted the feat/expr-doc branch October 20, 2024 20:50
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants