Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Concise Function Templates for Flask Backend using pyment #178

Open
SahanDisa opened this issue Dec 4, 2022 · 0 comments
Open

Concise Function Templates for Flask Backend using pyment #178

SahanDisa opened this issue Dec 4, 2022 · 0 comments

Comments

@SahanDisa
Copy link
Collaborator

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant