-
Notifications
You must be signed in to change notification settings - Fork 42
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
base: master
Are you sure you want to change the base?
Add docstrings #187
Conversation
@@ -11,6 +11,8 @@ | |||
|
|||
|
|||
class AddonDependency(): | |||
"""Get the version of the current addon |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
dependency is not version
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
.
5dc3995
to
3b4a7e5
Compare
kodi_addon_checker/addons/Addon.py
Outdated
@@ -12,6 +12,8 @@ | |||
|
|||
|
|||
class Addon(): | |||
"""Returns all the dependencies of an addon |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
or None
@Rechi are we using some specific format for docstrings? If not I would like to recommend REST format. |
@mzfr I noticed that some already existing docstrings are uniform. For eg:in main.py |
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).