search

xbmc / addon-check

Automatic checks for new repository submissions
GNU General Public License v3.0
52 stars 42 forks source link

doc strings are missing in lot of modules. #171

Closed LordGameleo closed 5 years ago

LordGameleo commented 5 years ago

While checking with pylint, it gives a lot of suggestions to add doc strings in the functions. 


tests/test_common.py:1:0: C0111: Missing module docstring (missing-docstring)
tests/test_common.py:6:0: E0401: Unable to import 'PIL' (import-error)
tests/test_common.py:19:0: C0111: Missing function docstring (missing-docstring)
tests/test_common.py:24:0: C0111: Missing function docstring (missing-docstring)
tests/test_common.py:29:0: C0111: Missing function docstring (missing-docstring)
tests/test_common.py:34:0: C0111: Missing function docstring (missing-docstring)
tests/test_common.py:39:0: C0111: Missing function docstring (missing-docstring)
tests/test_common.py:44:0: C0111: Missing function docstring (missing-docstring)
tests/test_common.py:49:0: C0111: Missing function docstring (missing-docstring)```
mzfr commented 5 years ago

Error on the second line is an import error which is because you don't have the PIL library installed. Also is it important to write doc string of test functions?

LordGameleo commented 5 years ago

docString are not that important for test functions. Its not just tests that is missing function docString.


kodi_addon_checker/reporter.py:44:0: C0301: Line too long (120/100) (line-too-long)
kodi_addon_checker/reporter.py:13:0: C0111: Missing class docstring (missing-docstring)
kodi_addon_checker/reporter.py:15:4: C0111: Missing method docstring (missing-docstring)
kodi_addon_checker/reporter.py:13:0: R0903: Too few public methods (1/2) (too-few-public-methods)
kodi_addon_checker/reporter.py:19:0: C0111: Missing class docstring (missing-docstring)
kodi_addon_checker/reporter.py:19:0: R0205: Class 'ReportManager' inherits from object, can be safely removed from bases in python3 (useless-object-inheritance)
kodi_addon_checker/reporter.py:23:4: C0111: Missing method docstring (missing-docstring)
kodi_addon_checker/reporter.py:37:4: C0103: Method name "getEnabledReporters" doesn't conform to snake_case naming style (invalid-name)
kodi_addon_checker/reporter.py:37:4: C0111: Missing method docstring (missing-docstring)
kodi_addon_checker/reporter.py:41:0: C0111: Missing function docstring (missing-docstring)```