Skip to content

Commit

Permalink
Krzysiek/datatypes reference (#5442)
Browse files Browse the repository at this point in the history
article on data types, a few adjustments in apidocs to include the type of elements that are stored in the column

GitOrigin-RevId: 3e7e93558b70ea1e6200b27053e41a127bed9292
  • Loading branch information
krzysiek-pathway authored and Manul from Pathway committed Feb 15, 2024
1 parent c916603 commit d2f0b5c
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 8 deletions.
2 changes: 1 addition & 1 deletion python/pathway/internals/table.py
Original file line number Diff line number Diff line change
Expand Up @@ -1969,7 +1969,7 @@ def sort(
Args:
table : pw.Table
The table to be sorted.
key : ColumnReference
key (ColumnExpression[int | float | datetime | str | bytes]):
An expression to sort by.
instance : ColumnReference or None
An expression with instance. Rows are sorted within an instance.
Expand Down
9 changes: 5 additions & 4 deletions python/pathway/stdlib/ordered/diff.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,11 @@ def diff(
according to the order defined by the column ``timestamp``.
Args:
- ``timestamp`` (``ColumnReference``): The column reference to the ``timestamp`` column on
which the order is computed.
- ``*values`` (``ColumnReference``): Variable-length argument representing the column
references to the ``values`` columns.
- timestamp (pw.ColumnReference[int | float | datetime | str | bytes]):
The column reference to the ``timestamp`` column on which the order is computed.
- *values (pw.ColumnReference[int | float | datetime]):
Variable-length argument representing the column references to the ``values`` columns.
Returns:
``Table``: A new table where each column is replaced with a new column containing
Expand Down
6 changes: 4 additions & 2 deletions python/pathway/stdlib/temporal/_interval_join.py
Original file line number Diff line number Diff line change
Expand Up @@ -596,8 +596,10 @@ def interval_join(
Args:
other: the right side of a join.
self_time: time expression in self.
other_time: time expression in other.
self_time (pw.ColumnExpression[int | float | datetime]):
time expression in self.
other_time (pw.ColumnExpression[int | float | datetime]):
time expression in other.
lower_bound: a lower bound on time difference between other_time
and self_time.
upper_bound: an upper bound on time difference between other_time
Expand Down
2 changes: 1 addition & 1 deletion python/pathway/stdlib/temporal/_window.py
Original file line number Diff line number Diff line change
Expand Up @@ -871,7 +871,7 @@ def windowby(
optionally with `instance` argument.
Args:
time_expr: Column expression used for windowing
time_expr (pw.ColumnExpression[int | float | datetime]): Column expression used for windowing
window: type window to use
instance: optional column expression to act as a shard key
Expand Down

0 comments on commit d2f0b5c

Please sign in to comment.