andras/great-ai
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases 4 Packages Wiki Activity Actions

Improve docstrings

Browse source
This commit is contained in:
Andras Schmelczer 2022-07-16 13:53:52 +02:00
parent eb143917be
commit 0dd5b6e8f4
No known key found for this signature in database
GPG key ID: 39260B5B0614A13E
8 changed files with 44 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

6
great_ai/parameters/parameter.py
View file

@ -19,6 +19,10 @@ def parameter(
) -> Callable[[F], F]:
"""Control the validation and logging of function parameters.
Basically, a parameter decorator. Unfortunately, Python does not have that concept,
thus, it's a method decorator that expects the name of the to-be-decorated
parameter.
Examples:
>>> @parameter('a')
... def my_function(a: int):
@ -39,7 +43,7 @@ def parameter(
great_ai.errors.argument_validation_error.ArgumentValidationError: ...
Args:
parameter_name: Name of parameter to consider
parameter_name: Name of parameter to consider.
validate: Optional validate to run against the concrete argument.
ArgumentValidationError is thrown when the return value is False.
disable_logging: Do not save the value in any active TracingContext.