etorres/rbackup
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docstrings for rbackup.struct.repository

Browse Source
This commit is contained in:
Eric Torres 2019-04-28 22:31:24 -07:00
parent 2e1bc6130e
commit 428865611d
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
rbackup/struct/repository.py
View File

@ -214,9 +214,9 @@ class Repository(Hierarchy):
"""Remove this repository from the filesystem. """Remove this repository from the filesystem.
By default, no snapshots are deleted. By default, no snapshots are deleted.
:param remove_snapshots: delete the data directory of this repository :param remove_snapshots: delete the data directory of this repository (default: ``False``)
:type remove_snapshots: bool :type remove_snapshots: bool
:param remove_repo_dir: remove the top-level directory of this repository :param remove_repo_dir: remove the top-level directory of this repository (default: ``False``)
:type remove_repo_dir: bool :type remove_repo_dir: bool
""" """
# We don't want to risk symlink attacks # We don't want to risk symlink attacks
@ -264,7 +264,7 @@ class Repository(Hierarchy):
If name is given and it is the name of a snapshot already If name is given and it is the name of a snapshot already
on the repository, that snapshot is overwritten instead. on the repository, that snapshot is overwritten instead.
:param name: the name of the snapshot :param name: the name of the snapshot (default: current date and time)
:type name: str :type name: str
:return: Snapshot object :return: Snapshot object
:raises ValueError: if name is an invalid value :raises ValueError: if name is an invalid value