Skip to content

Commit bf887c0

Browse files
committed
Clarify comment about function parameter elements
1 parent f87cd5f commit bf887c0

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/transformers/utils/auto_docstring.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1288,7 +1288,7 @@ def _process_parameter_type(param, param_name, func):
12881288
param_name (`str`): The name of the parameter
12891289
func (`function`): The function the parameter belongs to
12901290
"""
1291-
# a parameter for a function might have three basic elements: name, type
1291+
# a parameter for a function might have three basic elements: name, type hint, default value
12921292
# for example, it would be like (there are some whitespaces)
12931293
# age: int = 18 (if a param has no type hint, it would be like age=18)
12941294
parameter_str: str = str(param)

0 commit comments

Comments
 (0)