mirror of
https://github.com/clinton-hall/nzbToMedia.git
synced 2025-08-14 02:26:53 -07:00
Fix flake8-docstrings D401 First line should be in imperative mood
This commit is contained in:
parent
6f6c9bcc9d
commit
10b2eab3c5
5 changed files with 9 additions and 9 deletions
|
@ -20,7 +20,7 @@ class GitHub(object):
|
||||||
|
|
||||||
def commits(self):
|
def commits(self):
|
||||||
"""
|
"""
|
||||||
Uses the API to get a list of the 100 most recent commits from the specified user/repo/branch, starting from HEAD.
|
Get the 100 most recent commits from the specified user/repo/branch, starting from HEAD.
|
||||||
|
|
||||||
user: The github username of the person whose repo you're querying
|
user: The github username of the person whose repo you're querying
|
||||||
repo: The repo name to query
|
repo: The repo name to query
|
||||||
|
@ -35,7 +35,7 @@ class GitHub(object):
|
||||||
|
|
||||||
def compare(self, base, head, per_page=1):
|
def compare(self, base, head, per_page=1):
|
||||||
"""
|
"""
|
||||||
Uses the API to get a list of compares between base and head.
|
Get compares between base and head.
|
||||||
|
|
||||||
user: The github username of the person whose repo you're querying
|
user: The github username of the person whose repo you're querying
|
||||||
repo: The repo name to query
|
repo: The repo name to query
|
||||||
|
|
|
@ -127,7 +127,7 @@ class NTMRotatingLogHandler(object):
|
||||||
|
|
||||||
def _log_file_name(self, i):
|
def _log_file_name(self, i):
|
||||||
"""
|
"""
|
||||||
Returns a numbered log file name depending on i.
|
Return a numbered log file name depending on i.
|
||||||
|
|
||||||
If i==0 it just uses logName, if not it appends it to the extension
|
If i==0 it just uses logName, if not it appends it to the extension
|
||||||
e.g. (blah.log.3 for i == 3)
|
e.g. (blah.log.3 for i == 3)
|
||||||
|
@ -138,7 +138,7 @@ class NTMRotatingLogHandler(object):
|
||||||
|
|
||||||
def _num_logs(self):
|
def _num_logs(self):
|
||||||
"""
|
"""
|
||||||
Scans the log folder and figures out how many log files there are already on disk.
|
Scan the log folder and figure out how many log files there are already on disk.
|
||||||
|
|
||||||
Returns: The number of the last used file (eg. mylog.log.3 would return 3). If there are no logs it returns -1
|
Returns: The number of the last used file (eg. mylog.log.3 would return 3). If there are no logs it returns -1
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -29,7 +29,7 @@ def sanitize_name(name):
|
||||||
|
|
||||||
def clean_file_name(filename):
|
def clean_file_name(filename):
|
||||||
"""
|
"""
|
||||||
Cleans up nzb name by removing any . and _ characters and trailing hyphens.
|
Clean up nzb name by removing any . and _ characters and trailing hyphens.
|
||||||
|
|
||||||
Is basically equivalent to replacing all _ and . with a
|
Is basically equivalent to replacing all _ and . with a
|
||||||
space, but handles decimal numbers in string, for example:
|
space, but handles decimal numbers in string, for example:
|
||||||
|
|
|
@ -74,7 +74,7 @@ def get_dir_size(input_path):
|
||||||
|
|
||||||
|
|
||||||
def remove_empty_folders(path, remove_root=True):
|
def remove_empty_folders(path, remove_root=True):
|
||||||
"""Function to remove empty folders."""
|
"""Remove empty folders."""
|
||||||
if not os.path.isdir(path):
|
if not os.path.isdir(path):
|
||||||
return
|
return
|
||||||
|
|
||||||
|
|
|
@ -38,7 +38,7 @@ class CheckVersion(object):
|
||||||
|
|
||||||
def find_install_type(self):
|
def find_install_type(self):
|
||||||
"""
|
"""
|
||||||
Determines how this copy of SB was installed.
|
Determine how this copy of SB was installed.
|
||||||
|
|
||||||
returns: type of installation. Possible values are:
|
returns: type of installation. Possible values are:
|
||||||
'win': any compiled windows build
|
'win': any compiled windows build
|
||||||
|
@ -55,7 +55,7 @@ class CheckVersion(object):
|
||||||
|
|
||||||
def check_for_new_version(self, force=False):
|
def check_for_new_version(self, force=False):
|
||||||
"""
|
"""
|
||||||
Checks the internet for a newer version.
|
Check the internet for a newer version.
|
||||||
|
|
||||||
returns: bool, True for new version or False for no new version.
|
returns: bool, True for new version or False for no new version.
|
||||||
|
|
||||||
|
@ -207,7 +207,7 @@ class GitUpdateManager(UpdateManager):
|
||||||
|
|
||||||
def _find_installed_version(self):
|
def _find_installed_version(self):
|
||||||
"""
|
"""
|
||||||
Attempts to find the currently installed version of Sick Beard.
|
Attempt to find the currently installed version of Sick Beard.
|
||||||
|
|
||||||
Uses git show to get commit version.
|
Uses git show to get commit version.
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue