Skip to content

Commit

Permalink
tiny docstring update
Browse files Browse the repository at this point in the history
  • Loading branch information
eimrek committed Dec 7, 2023
1 parent f5476a5 commit fd2d038
Showing 1 changed file with 2 additions and 12 deletions.
14 changes: 2 additions & 12 deletions disk_objectstore/backup_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,7 @@ def check_path_exists(self, path: Path) -> bool:
return self.run_cmd(cmd)[0]

def validate(self):
"""Validate the backup config inputs
:return:
True if validation passes, False otherwise.
"""
"""Validate the backup config inputs"""
if self.keep < 0:
raise BackupError(
"Input validation failed: keep variable can't be negative!"
Expand Down Expand Up @@ -151,8 +147,6 @@ def call_rsync( # pylint: disable=too-many-arguments
Add a trailing slash to the source path. This makes rsync copy the contents
of the folder instead of the folder itself.
:return:
True if successful and False if unsuccessful.
"""

assert "rsync" in self.exes
Expand Down Expand Up @@ -238,7 +232,7 @@ def delete_old_backups(self):
else:
self.logger.warning("Warning: couldn't delete old backup: %s", folder)

def backup_auto_folders(self, backup_func: Callable):
def backup_auto_folders(self, backup_func: Callable) -> None:
"""Create a backup, managing live and previous backup folders automatically
The running backup is done to `<path>/live-backup`. When it completes, it is moved to
Expand All @@ -250,8 +244,6 @@ def backup_auto_folders(self, backup_func: Callable):
Function that is used to make a single backup. Needs to have two arguments: path and
previous_backup location (which can be None).
:return:
True is successful and False if unsuccessful.
"""

live_folder = self.path / "live-backup"
Expand Down Expand Up @@ -331,8 +323,6 @@ def backup_container(
2) sqlite database;
3) packed files.
:return:
True if successful and False if unsuccessful.
"""

container_root_path = container.get_folder()
Expand Down

0 comments on commit fd2d038

Please sign in to comment.