nils-wisiol/pypuf

Fix linter messages tools.py

Closed this issue · 0 comments

In pr #63 I integrated code analysis to the project. I recognized that the some functions have inconsistent doc strings regarding to the whole project. Good doc string should look like this:

"""
Function description. Explain the benefit of this function.
:param parameter_name: type
                                       Parameter description
:return: type
            Description of the return value     
"""

For some functions I am not able to create good doc string. Like in #66 please give a meaningful name for sss. I Marked every doc string with TODO which should be improved.