Skip to content

Commit 7e28012

Browse files
committed
docs: improve docstring for string_literal function for clarity
1 parent 5e03c3a commit 7e28012

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

docs/source/user-guide/common-operations/functions.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ DataFusion offers mathematical functions such as :py:func:`~datafusion.functions
3838

3939
.. ipython:: python
4040
41-
from datafusion import col, literal, utf8_literal
41+
from datafusion import col, literal, string_literal
4242
from datafusion import functions as f
4343
4444
df.select(
@@ -112,8 +112,8 @@ Casting expressions to different data types using :py:func:`~datafusion.function
112112
.. ipython:: python
113113
114114
df.select(
115-
f.arrow_cast(col('"Total"'), utf8_literal("Float64")).alias("total_as_float"),
116-
f.arrow_cast(col('"Total"'), utf8_literal("Int32")).alias("total_as_int")
115+
f.arrow_cast(col('"Total"'), string_literal("Float64")).alias("total_as_float"),
116+
f.arrow_cast(col('"Total"'), str_lit("Int32")).alias("total_as_int")
117117
)
118118
119119
Other

python/datafusion/__init__.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,13 +109,14 @@ def literal(value):
109109

110110
def string_literal(value):
111111
"""Create a UTF8 literal expression.
112-
It differs from `literal` creates a UTF8view literal.
112+
113+
It differs from `literal` which creates a UTF8view literal.
113114
"""
114115
return Expr.string_literal(value)
115116

116117

117118
def str_lit(value):
118-
"""Alias for `string_literal`"""
119+
"""Alias for `string_literal`."""
119120
return string_literal(value)
120121

121122

0 commit comments

Comments
 (0)