From fe799d867c1a1ce18ed8fb66c508e428390b2200 Mon Sep 17 00:00:00 2001 From: Eric Torres Date: Sun, 14 Apr 2019 08:45:17 -0700 Subject: [PATCH] Fix incorrect exception docstrings --- rbackup/config.py | 2 +- rbackup/package_managers/packagemanager.py | 4 ++-- rbackup/rsync.py | 2 +- rbackup/struct/repository.py | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/rbackup/config.py b/rbackup/config.py index ea560fe..de7ebc2 100644 --- a/rbackup/config.py +++ b/rbackup/config.py @@ -97,7 +97,7 @@ def parse_configfile(): :returns: object used to parse config file :rtype: ConfigParser object - :raises: FileNotFoundError if path does not exist + :raises FileNotFoundError: if path does not exist """ if not MAIN_CONFIG_FILE.is_file(): raise FileNotFoundError(f"{MAIN_CONFIG_FILE} does not exist") diff --git a/rbackup/package_managers/packagemanager.py b/rbackup/package_managers/packagemanager.py index 3dd60e9..81a898e 100644 --- a/rbackup/package_managers/packagemanager.py +++ b/rbackup/package_managers/packagemanager.py @@ -70,13 +70,13 @@ class PackageManager: meant to be called from a subclass in a separate module. All arguments and keyword-only arguments are passed directly - to the packagemanagerk + to the PackageManager object. :param compress: compression mode :type compress: str :returns: the path to the created file :rtype: path-like object - :raises: ValueError if compress is not in packagemanager.VALID_DB_COMPRESS_MODES + :raises ValueError: if compress is not in packagemanager.VALID_DB_COMPRESS_MODES """ if compress is not None and compress not in VALID_DB_COMPRESS_MODES: raise ValueError(f"{compress} is not a valid compress mode") diff --git a/rbackup/rsync.py b/rbackup/rsync.py index f6511c2..44acd79 100644 --- a/rbackup/rsync.py +++ b/rbackup/rsync.py @@ -21,7 +21,7 @@ def rsync(*args): :param args: all arguments to pass to rsync :type args: str - :raises: subprocess.CalledProcessError if rsync process failed + :raises subprocess.CalledProcessError: if rsync process failed """ cmd = [_RSYNC_BIN, *args] diff --git a/rbackup/struct/repository.py b/rbackup/struct/repository.py index 5d5d163..8e02a60 100644 --- a/rbackup/struct/repository.py +++ b/rbackup/struct/repository.py @@ -188,7 +188,7 @@ class Repository(Hierarchy): :param name: the name of the snapshot :type name: str :return: Snapshot object - :raises: ValueError if name is an invalid value + :raises ValueError: if name is an invalid value """ syslog.debug("Creating snapshot")