You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
According to the Google convention, functions with type hinted arguments do not need to have the types inside the docstring (see example below). I think the same is true for whether or not they are optional.
Currently, most of our docstrings do have the types (and optionality) annotated, despite them all being type hinted already. This makes them a bit clunky and lengthy.
Do we want to update these or leave them as is?
deffunction_with_pep484_type_annotations(param1: int, param2: str) ->bool:
"""Example function with PEP 484 type annotations. Args: param1: The first parameter. param2: The second parameter. Returns: The return value. True for success, False otherwise. """
The text was updated successfully, but these errors were encountered:
It's a nice improvement :) I'd say it's not a priority and as it is does not limit the usage or the clarity of the docs, but up to you if you wish to pick this up.
According to the Google convention, functions with type hinted arguments do not need to have the types inside the docstring (see example below). I think the same is true for whether or not they are optional.
Currently, most of our docstrings do have the types (and optionality) annotated, despite them all being type hinted already. This makes them a bit clunky and lengthy.
Do we want to update these or leave them as is?
The text was updated successfully, but these errors were encountered: