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

More docstrings #34

Merged
merged 5 commits into from
Mar 31, 2024
Merged

More docstrings #34

merged 5 commits into from
Mar 31, 2024

Conversation

frnmst
Copy link
Contributor

@frnmst frnmst commented Mar 30, 2024

Docstrings for:

  • narwhals.dataframe.DataFrame.unique
  • narwhals.dataframe.DataFrame.sort
  • narwhals.dataframe.DataFrame.join

You can create a new base docstrings branch from your main before merging since I can't do it with my user

frnmst and others added 5 commits March 30, 2024 16:52
- Add `narwhals.dataframe.DataFrame.unique` docstring
- Add `narwhals.dataframe.DataFrame.sort` docstring
- Add `narwhals.dataframe.DataFrame.join` docstring
- Fix return string
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.

nice one, thanks @frnmst !

I just kept join inner for now, as the others aren't (yet) supported - but I'll restore these example later when they are

@MarcoGorelli MarcoGorelli merged commit c0683ff into narwhals-dev:main Mar 31, 2024
11 checks passed
@frnmst frnmst deleted the docstrings branch March 31, 2024 21:04
@frnmst
Copy link
Contributor Author

frnmst commented Mar 31, 2024

nice one, thanks @frnmst !

I just kept join inner for now, as the others aren't (yet) supported - but I'll restore these example later when they are

Ah, OK. I though the fact that was working as expected it meant that it was implemented.

But now I just noticed:

        if how not in ["inner"]:                                                
            msg = "Only inner join supported for now, others coming soon"       
            raise ValueError(msg)

in _pandas_like/dataframe.py. But this exception wasn't triggered for those examples.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants