Skip to content

Commit eb4bc9f

Browse files
timsaucerclaude
andcommitted
docs(udf): drop return-type cross-refs in udf/udaf/udwf docstrings
The `:py:class:` link back to the wrapper class shadowed the return type annotation and risked drifting if the class were moved. Replace with a plain backtick literal; surrounding contract prose is unchanged. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent fe366d9 commit eb4bc9f

1 file changed

Lines changed: 14 additions & 15 deletions

File tree

python/datafusion/context.py

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1320,11 +1320,11 @@ def deregister_udwf(self, name: str) -> None:
13201320
def udf(self, name: str) -> ScalarUDF:
13211321
"""Look up a registered scalar UDF by name.
13221322
1323-
Returns the same :py:class:`~datafusion.user_defined.ScalarUDF`
1324-
wrapper that :py:meth:`register_udf` accepts, so it can be invoked
1325-
as an expression in the DataFrame API or re-registered into a
1326-
different :py:class:`SessionContext`. Built-in scalar functions
1327-
from the session's function registry are also looked up.
1323+
Returns the same ``ScalarUDF`` wrapper that :py:meth:`register_udf`
1324+
accepts, so it can be invoked as an expression in the DataFrame API
1325+
or re-registered into a different :py:class:`SessionContext`.
1326+
Built-in scalar functions from the session's function registry are
1327+
also looked up.
13281328
13291329
Args:
13301330
name: Name of the registered scalar UDF.
@@ -1366,11 +1366,10 @@ def udf(self, name: str) -> ScalarUDF:
13661366
def udaf(self, name: str) -> AggregateUDF:
13671367
"""Look up a registered aggregate UDF by name.
13681368
1369-
Returns the same :py:class:`~datafusion.user_defined.AggregateUDF`
1370-
wrapper that :py:meth:`register_udaf` accepts. Built-in aggregate
1371-
functions such as ``sum`` or ``avg`` are also discoverable through
1372-
this lookup. See :py:meth:`udf` for a worked late-binding example;
1373-
the pattern is identical for aggregates.
1369+
Returns the same ``AggregateUDF`` wrapper that :py:meth:`register_udaf`
1370+
accepts. Built-in aggregate functions such as ``sum`` or ``avg`` are
1371+
also discoverable through this lookup. See :py:meth:`udf` for a worked
1372+
late-binding example; the pattern is identical for aggregates.
13741373
13751374
Args:
13761375
name: Name of the registered aggregate UDF.
@@ -1397,11 +1396,11 @@ def udaf(self, name: str) -> AggregateUDF:
13971396
def udwf(self, name: str) -> WindowUDF:
13981397
"""Look up a registered window UDF by name.
13991398
1400-
Returns the same :py:class:`~datafusion.user_defined.WindowUDF`
1401-
wrapper that :py:meth:`register_udwf` accepts. Built-in window
1402-
functions such as ``row_number`` or ``rank`` are also discoverable
1403-
through this lookup. See :py:meth:`udf` for a worked late-binding
1404-
example; the pattern is identical for window functions.
1399+
Returns the same ``WindowUDF`` wrapper that :py:meth:`register_udwf`
1400+
accepts. Built-in window functions such as ``row_number`` or ``rank``
1401+
are also discoverable through this lookup. See :py:meth:`udf` for a
1402+
worked late-binding example; the pattern is identical for window
1403+
functions.
14051404
14061405
Args:
14071406
name: Name of the registered window UDF.

0 commit comments

Comments
 (0)