Skip to content

Commit

Permalink
docs: replace df_any/s_any with df/s (#621)
Browse files Browse the repository at this point in the history
* replace some df_any /w df

* replace s_any /w s
  • Loading branch information
aidoskanapyanov authored Jul 25, 2024
1 parent 50aa329 commit d7337e8
Show file tree
Hide file tree
Showing 12 changed files with 499 additions and 507 deletions.
4 changes: 2 additions & 2 deletions docs/api-reference/typing.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,8 @@ from narwhals.typing import IntoDataFrameT, DataFrameT

df = pl.DataFrame({'a': [1,2,3]})

def func(df_any: IntoDataFrameT) -> IntoDataFrameT:
df = nw.from_native(df_any, eager_only=True)
def func(df: IntoDataFrameT) -> IntoDataFrameT:
df = nw.from_native(df, eager_only=True)
return nw.to_native(df.select(b=nw.col('a')))

reveal_type(func(df))
Expand Down
2 changes: 1 addition & 1 deletion docs/basics/complete_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ from typing import Any

class StandardScaler:
@nw.narwhalify(eager_only=True)
def fit(self, df_any: nw.DataFrame[Any]) -> None:
def fit(self, df: nw.DataFrame[Any]) -> None:
self._means = {col: df[col].mean() for col in df.columns}
self._std_devs = {col: df[col].std() for col in df.columns}
```
Expand Down
2 changes: 1 addition & 1 deletion docs/levels.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import narwhals as nw
from narwhals.schema import Schema


def func(df_any: Any) -> Schema:
def func(df: Any) -> Schema:
df = nw.from_native(df, eager_or_interchange_only=True)
return df.schema
```
Expand Down
4 changes: 2 additions & 2 deletions docs/other/pandas_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Let's learn about what Narwhals promises.
```python exec="1" source="above" session="ex1"
import narwhals as nw

def my_func(df_any):
df = nw.from_native(df_any)
def my_func(df):
df = nw.from_native(df)
df = df.with_columns(a_plus_one=nw.col('a')+1)
return nw.to_native(df)
```
Expand Down
Loading

0 comments on commit d7337e8

Please sign in to comment.