docs: use type hints + from_native/to_native in series.py #1408
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
MarcoGorelli
commented
Nov 20, 2024
Comment on lines
-1585
to
+1595
| >>> def my_library_agnostic_function(s_native: IntoSeriesT) -> IntoSeriesT: | ||
| >>> def agnostic_sort(s_native: IntoSeriesT) -> IntoSeriesT: | ||
| ... s = nw.from_native(s_native, series_only=True) | ||
| ... return s.sort().to_native() | ||
|
|
||
| >>> @nw.narwhalify | ||
| ... def func_descend(s): | ||
| >>> def agnostic_sort_descending(s_native: IntoSeriesT) -> IntoSeriesT: | ||
| ... s = nw.from_native(s_native, series_only=True) | ||
| ... return s.sort(descending=True).to_native() | ||
|
|
||
| We can then pass either pandas or Polars to `func`: | ||
| We can then pass either pandas or Polars to `agnostic_sort`: | ||
|
|
||
| >>> my_library_agnostic_function(s_pd) | ||
| >>> agnostic_sort(s_pd) |
There was a problem hiding this comment.
🤔 ok i do like the way this looks...nice one @FBruzzesi
There was a problem hiding this comment.
Thanks! I like it as well! Drawback is... a bit more effort 😂
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.
Start updating more docstrings, pending discussion in #1407
What type of PR is this? (check all applicable)
Related issues
Checklist
If you have comments or can explain your changes, please do so below