Skip to content

Commit edf283e

Browse files
committed
docs: Add traling docs to aliases
1 parent bdf8934 commit edf283e

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

narwhals/_compliant/typing.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,18 @@
112112
LazyExprT_contra = TypeVar("LazyExprT_contra", bound=LazyExprAny, contravariant=True)
113113

114114
AliasNames: TypeAlias = Callable[[Sequence[str]], Sequence[str]]
115+
"""A function aliasing a *sequence* of column names."""
116+
115117
AliasName: TypeAlias = Callable[[str], str]
118+
"""A function aliasing a *single* column name."""
119+
116120
EvalSeries: TypeAlias = Callable[
117121
[CompliantFrameT], Sequence[CompliantSeriesOrNativeExprT]
118122
]
123+
"""A function from a `Frame` to a sequence of `Series`*.
124+
125+
See [underwater unicorn magic](https://narwhals-dev.github.io/narwhals/how_it_works/).
126+
"""
127+
119128
EvalNames: TypeAlias = Callable[[CompliantFrameT], Sequence[str]]
129+
"""**NEEDS DOC**"""

0 commit comments

Comments
 (0)