search

xbmc / addon-check

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

Add docstrings #187

Open mzfr opened 5 years ago

mzfr commented 5 years ago

Fixes #179

I haven't added docstring to any method/class that doesn't have any code in it(not sure what to write in them).

LordGameleo commented 5 years ago

@Rechi are we using some specific format for docstrings? If not I would like to recommend REST format. https://www.python.org/dev/peps/pep-0287/

LordGameleo commented 5 years ago

@mzfr I noticed that some already existing docstrings are uniform. For eg:in main.py def check_artifact(artifact_path, args, all_repo_addons): is using REST format (different from what you are using) Please correct them as well in your PR while you are at it. It is just my opinion to use REST format.