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

Add docstrings #187

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add docstrings #187

wants to merge 1 commit into from

Conversation

mzfr
Copy link
Contributor

@mzfr mzfr commented Mar 19, 2019

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).

kodi_addon_checker/addons/Addon.py Outdated Show resolved Hide resolved
kodi_addon_checker/addons/Addon.py Outdated Show resolved Hide resolved
kodi_addon_checker/addons/Addon.py Outdated Show resolved Hide resolved
@@ -11,6 +11,8 @@


class AddonDependency():
"""Get the version of the current addon
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dependency is not version

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But if you look at the code it's getting the version from the xml file

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is reading the minum version of the dependency from an ET.Element.

kodi_addon_checker/addons/Repository.py Outdated Show resolved Hide resolved
kodi_addon_checker/check_url.py Outdated Show resolved Hide resolved
kodi_addon_checker/common.py Outdated Show resolved Hide resolved
kodi_addon_checker/config.py Outdated Show resolved Hide resolved
kodi_addon_checker/schema_validation.py Outdated Show resolved Hide resolved
kodi_addon_checker/schema_validation.py Outdated Show resolved Hide resolved
@mzfr mzfr force-pushed the pylint-fixes branch 2 times, most recently from 5dc3995 to 3b4a7e5 Compare March 19, 2019 15:28
@@ -12,6 +12,8 @@


class Addon():
"""Returns all the dependencies of an addon
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The class doesn't return anything. Also id and version are safed too.

@@ -11,6 +11,8 @@


class AddonDependency():
"""Get the version of the current addon
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is reading the minum version of the dependency from an ET.Element.

@@ -115,6 +115,18 @@ def _validate(xml, schemapath):


def check_version(branch_name, schema_file):
"""Check whether the schema files for the specific
branch exists or not and if not then return the
highest available variant of the schema file
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or None

@LordGameleo
Copy link
Contributor

@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
Copy link
Contributor

@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.

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

Successfully merging this pull request may close these issues.

Correct the mentioned pylint errors to get perfect 10. (missing-docstring)
3 participants