scorelab / tensormap

TensorMap will be a web application that will allow the users to create machine learning algorithms visually. TensorMap will support reverse engineering of the visual layout to a Tensorflow implementation in preferred languages. The goal of the project is to let the beginners play with machine learning algorithms in Tensorflow without less background knowledge about the library.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Concise Function Templates for Flask Backend using pyment

SahanDisa opened this issue · comments

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