docs: clean lazyframe docstrings #1466
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
documentation
There was a problem hiding this comment.
Thanks @AlessandroMiola for doing this! just got a minor comment which might be good to address while we're doing these
narwhals/dataframe.py
Outdated
| ... return df.join(other_any, left_on="ham", right_on="ham") | ||
| >>> def agnostic_join_on_ham( | ||
| ... df_native: IntoFrameT, | ||
| ... other_any_native: IntoFrameT, |
There was a problem hiding this comment.
should this be other_native?
narwhals/dataframe.py
Outdated
| ... return df.join_asof(other_any, on="datetime", strategy=strategy) | ||
| >>> def agnostic_join_asof_datetime( | ||
| ... df_native: IntoFrameT, | ||
| ... other_any_native: IntoFrameT, |
narwhals/dataframe.py
Outdated
| ... return df.join_asof(other_any, on="datetime", by="ticker") | ||
| >>> def agnostic_join_asof_datetime_by_ticker( | ||
| ... df_native: IntoFrameT, | ||
| ... other_any_native: IntoFrameT, |
MarcoGorelli
approved these changes
Nov 30, 2024
There was a problem hiding this comment.
thanks @AlessandroMiola !
btw reckon the lazyframe docstrings should perhaps all show examples with just:
- polars LazyFrame
- Dask
?
Agree! I can refine them further |
10 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this? (check all applicable)
Related issues
NA
Checklist
If you have comments or can explain your changes, please do so below
Cleans lazyframe docstrings
lf_plfrom_native/to_nativeinstead ofnarwhalifyagnostic_funcinstead offunc