Skip to content

Commit

Permalink
Fix docstrings.
Browse files Browse the repository at this point in the history
  • Loading branch information
egparedes committed Nov 12, 2023
1 parent 10b3959 commit b5b4ada
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions src/gt4py/eve/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -259,15 +259,16 @@ def with_fluid_partial( # noqa: F811 # redefinition of unused function
) -> Union[Callable[..., Any], Callable[[Callable[..., Any]], Callable[..., Any]]]:
"""
A decorator that adds a `partial` attribute to the decorated function.
The `partial` attribute is a function that behaves like `functools.partial`,
but also supports partial application of the decorated function.
but also supports partial application of the decorated function. It can be
used both as a bare or a parameterized decorator.
Args:
func: The function to decorate.
Returns:
If `func` is not `None`, returns the decorated function.
Otherwise, returns a decorator that can be used to decorate a function.
Returns the decorated function with an extra `.partial()` attribute.
Example:
>>> @with_fluid_partial
Expand Down

0 comments on commit b5b4ada

Please sign in to comment.