search

itom-project / itom

itom core repository
https://itom-project.github.io/
Other
13 stars 5 forks source link

Default value by docstring generator #267

Closed photoniker closed 10 months ago

photoniker commented 10 months ago

This PR adds the default values of optional arguments by the docstring generator. Notation according to google style was implemented

def func(val1, val2: int, val3: float = 1.0, val4: str = None):
    """

    Args:
        val1 (TYPE): DESCRIPTION
        val2 (int): DESCRIPTION
        val3 (float, optional): DESCRIPTION. Defaults to 1.0.
        val4 (str, optional): DESCRIPTION. Defaults to None.
    """