docs: add from/to_native in documentation examples
#1461
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
FBruzzesi
commented
Nov 29, 2024
| ```python | ||
| import narwhals.stable.v1 as nw | ||
| from narwhals.typing import FrameT | ||
| === "from/to_native" |
There was a problem hiding this comment.
I called this tab from/to_native everywhere - let's figure out a better title
Comment on lines
+231
to
+235
| from narwhals.typing import DataFrameT | ||
|
|
||
|
|
||
| @nw.narwhalify(eager_only=True) | ||
| def func(df: nw.DataFrame[Any], s: nw.Series, col_name: str) -> int: | ||
| def func(df: DataFrameT, s: nw.Series, col_name: str) -> int: |
There was a problem hiding this comment.
should we be using a TypeVar when it's only used in one place? I think this one might be better staying as nw.DataFrame[Any]?
| def my_func(df: nw.DataFrame) -> float | None: | ||
| return df["a"].mean() | ||
| ``` | ||
| def my_func(df: IntoDataFrameT) -> float | None: |
There was a problem hiding this comment.
same comment about typevar
|
|
||
|
|
||
| @nw.narwhalify(eager_only=True) | ||
| def my_func(df: DataFrameT) -> float | None: |
MarcoGorelli
approved these changes
Nov 29, 2024
There was a problem hiding this comment.
thanks @FBruzzesi
sorry, updating my verdict on typevars, if mypy doesn't complain then I shouldn't be bothering with commenting on it in reviews
Feel free to merge if you're happy with the "from/to_native" title (personally I think it's good)
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
narwhalifyin the tutorial? #1372Checklist
If you have comments or can explain your changes, please do so below
Adds both options in all the documentation examples by using tabs