Skip to content

Commit 43e2529

Browse files
committed
Don't add examples for aliases
1 parent 4bebc2c commit 43e2529

File tree

1 file changed

+6
-28
lines changed

1 file changed

+6
-28
lines changed

python/datafusion/functions.py

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -373,33 +373,17 @@ def array_to_string(expr: Expr, delimiter: Expr) -> Expr:
373373
def array_join(expr: Expr, delimiter: Expr) -> Expr:
374374
"""Converts each element to its text representation.
375375
376-
This is an alias for :py:func:`array_to_string`.
377-
378-
Examples:
379-
---------
380-
>>> ctx = dfn.SessionContext()
381-
>>> df = ctx.from_pydict({"a": [[1, 2, 3]]})
382-
>>> result = df.select(
383-
... dfn.functions.array_join(dfn.col("a"), dfn.lit("-")).alias("s"))
384-
>>> result.collect_column("s")[0].as_py()
385-
'1-2-3'
376+
See Also:
377+
This is an alias for :py:func:`array_to_string`.
386378
"""
387379
return array_to_string(expr, delimiter)
388380

389381

390382
def list_to_string(expr: Expr, delimiter: Expr) -> Expr:
391383
"""Converts each element to its text representation.
392384
393-
This is an alias for :py:func:`array_to_string`.
394-
395-
Examples:
396-
---------
397-
>>> ctx = dfn.SessionContext()
398-
>>> df = ctx.from_pydict({"a": [[4, 5, 6]]})
399-
>>> result = df.select(
400-
... dfn.functions.list_to_string(dfn.col("a"), dfn.lit(",")).alias("s"))
401-
>>> result.collect_column("s")[0].as_py()
402-
'4,5,6'
385+
See Also:
386+
This is an alias for :py:func:`array_to_string`.
403387
"""
404388
return array_to_string(expr, delimiter)
405389

@@ -409,14 +393,8 @@ def list_join(expr: Expr, delimiter: Expr) -> Expr:
409393
410394
This is an alias for :py:func:`array_to_string`.
411395
412-
Examples:
413-
---------
414-
>>> ctx = dfn.SessionContext()
415-
>>> df = ctx.from_pydict({"a": [[7, 8, 9]]})
416-
>>> result = df.select(
417-
... dfn.functions.list_join(dfn.col("a"), dfn.lit("|")).alias("s"))
418-
>>> result.collect_column("s")[0].as_py()
419-
'7|8|9'
396+
See Also:
397+
This is an alias for :py:func:`array_to_string`.
420398
"""
421399
return array_to_string(expr, delimiter)
422400

0 commit comments

Comments
 (0)