Feature Request
Current doctstrings might include an Args section where parameters have type information (eg anumber (int): a number). Since we aim to add type hints to all variables, this creates redundant information. For simplicity and maintanability, shouldn't we only use type hints for info relative to types ?
We would have something like:
def function_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.
"""
This post discusses this question:
https://stackoverflow.com/questions/69322595/duplicate-information-in-typing-and-docstring
Feature Request
Current doctstrings might include an
Argssection where parameters have type information (eganumber (int): a number). Since we aim to add type hints to all variables, this creates redundant information. For simplicity and maintanability, shouldn't we only use type hints for info relative to types ?We would have something like:
This post discusses this question:
https://stackoverflow.com/questions/69322595/duplicate-information-in-typing-and-docstring