autoDocstring generator

[Raccoonn]

Hello,

I have been looking for new opportunities and in my search I found this style guide. I made a .mustache configuration file for the VSC extension autoDoctstring that will automatically generate this docstring style with type hinting. Working on sharpening my skills, hope it may help :)

https://github.com/Raccoonn/auto-docstring-mustaches/blob/main/dg-docstrings.mustache

Example:

def foo(first: int, second: str, optional: str='hello', another: int=5) -> typing.Iterator[int]:
    """
    DESCRIPTION: _summary_
    
    PARAMETERS: first (REQ, int) - _description_     
                second (REQ, str) - _description_     
                			
                optional (OPT, str), by default 'hello' - _description_     
                another (OPT, int), by default 5 - _description_     
                
    RETURNS:  typing.Iterator[int] - _description_     
             
    YIELDS: Iterator[typing.Iterator[int]] - _description_     
             
    EXCEPTIONS: e1 - _description_     
             
    """
    for x in range(10):
        try:
            yield x
        except ValueError as e1:
            raise e1