Skip to content

Concise Function Templates for Flask Backend using pyment #178

@SahanDisa

Description

@SahanDisa

Is your feature request related to a problem? Please describe.
Better documentation always improves the reliability and maintainability of the codebase and the current flask backend doesn't provide explicit function documentation in the python scripts.

Describe the solution you'd like
pyment is a NumPy style function documentation template generator for the python scripts. For more information, refer to the https://github.com/dadadel/pyment

Additional context
Screenshots of the feature request are mentioned here.

tensormap

The above feature request will add template documentation to each function mentioned and briefly describe the function arguments.

** Format **

def func(param1=True, param2: str = 'default val'):
    '''Description of func with docstring groups style.

    Params:
        param1 - descr of param1 that has True for default value.
        param2 - descr of param2

    Returns:
        some value

    Raises:
        keyError: raises key exception
        TypeError: raises type exception

    '''
    pass

class A:
    def method(self, param1, param2=None) -> int:
        pass

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions