Skip to content

Commit 66f1a04

Browse files
committed
Actually remove all for example calls in favor of docstrings
1 parent abe668d commit 66f1a04

File tree

1 file changed

+0
-43
lines changed

1 file changed

+0
-43
lines changed

python/datafusion/functions.py

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -2009,10 +2009,6 @@ def array_agg(
20092009
distinct: If True, a single entry for each distinct value will be in the result
20102010
filter: If provided, only compute against rows for which the filter is True
20112011
order_by: Order the resultant array values. Accepts column names or expressions.
2012-
2013-
For example::
2014-
2015-
df.aggregate([], array_agg(col("a"), order_by="b"))
20162012
"""
20172013
order_by_raw = sort_list_to_raw_sort_list(order_by)
20182014
filter_raw = filter.expr if filter is not None else None
@@ -2597,10 +2593,6 @@ def nth_value(
25972593
column names or expressions.
25982594
null_treatment: Assign whether to respect or ignore null values.
25992595
2600-
For example::
2601-
2602-
df.aggregate([], nth_value(col("a"), 2, order_by="ts"))
2603-
26042596
Examples:
26052597
---------
26062598
>>> ctx = dfn.SessionContext()
@@ -2745,10 +2737,6 @@ def lead(
27452737
order_by: Set ordering within the window frame. Accepts
27462738
column names or expressions.
27472739
2748-
For example::
2749-
2750-
lead(col("b"), order_by="ts")
2751-
27522740
Examples:
27532741
---------
27542742
>>> ctx = dfn.SessionContext()
@@ -2810,10 +2798,6 @@ def lag(
28102798
order_by: Set ordering within the window frame. Accepts
28112799
column names or expressions.
28122800
2813-
For example::
2814-
2815-
lag(col("b"), order_by="ts")
2816-
28172801
Examples:
28182802
---------
28192803
>>> ctx = dfn.SessionContext()
@@ -2865,10 +2849,6 @@ def row_number(
28652849
order_by: Set ordering within the window frame. Accepts
28662850
column names or expressions.
28672851
2868-
For example::
2869-
2870-
row_number(order_by="points")
2871-
28722852
Examples:
28732853
---------
28742854
>>> ctx = dfn.SessionContext()
@@ -2918,10 +2898,6 @@ def rank(
29182898
order_by: Set ordering within the window frame. Accepts
29192899
column names or expressions.
29202900
2921-
For example::
2922-
2923-
rank(order_by="points")
2924-
29252901
Examples:
29262902
---------
29272903
>>> ctx = dfn.SessionContext()
@@ -2965,10 +2941,6 @@ def dense_rank(
29652941
order_by: Set ordering within the window frame. Accepts
29662942
column names or expressions.
29672943
2968-
For example::
2969-
2970-
dense_rank(order_by="points")
2971-
29722944
Examples:
29732945
---------
29742946
>>> ctx = dfn.SessionContext()
@@ -3014,9 +2986,6 @@ def percent_rank(
30142986
order_by: Set ordering within the window frame. Accepts
30152987
column names or expressions.
30162988
3017-
For example::
3018-
3019-
percent_rank(order_by="points")
30202989
30212990
Examples:
30222991
---------
@@ -3063,10 +3032,6 @@ def cume_dist(
30633032
order_by: Set ordering within the window frame. Accepts
30643033
column names or expressions.
30653034
3066-
For example::
3067-
3068-
cume_dist(order_by="points")
3069-
30703035
Examples:
30713036
---------
30723037
>>> ctx = dfn.SessionContext()
@@ -3123,10 +3088,6 @@ def ntile(
31233088
order_by: Set ordering within the window frame. Accepts
31243089
column names or expressions.
31253090
3126-
For example::
3127-
3128-
ntile(3, order_by="points")
3129-
31303091
Examples:
31313092
---------
31323093
>>> ctx = dfn.SessionContext()
@@ -3169,10 +3130,6 @@ def string_agg(
31693130
filter: If provided, only compute against rows for which the filter is True
31703131
order_by: Set the ordering of the expression to evaluate. Accepts
31713132
column names or expressions.
3172-
3173-
For example::
3174-
3175-
df.aggregate([], string_agg(col("a"), ",", order_by="b"))
31763133
"""
31773134
order_by_raw = sort_list_to_raw_sort_list(order_by)
31783135
filter_raw = filter.expr if filter is not None else None

0 commit comments

Comments
 (0)