Docstring updates

This commit is contained in:
Eric Torres 2019-04-10 17:56:50 -07:00
parent cffbc3f268
commit 7583cd2a34
2 changed files with 4 additions and 3 deletions

View File

@ -33,6 +33,7 @@ class Hierarchy(PathLike):
Methods
-------
* gen_metadata - generate the metadata for this Hierarchy
* read_metadata - read this Hierarchy's metadata from a file
and return it
* write_metadata - write this Hierarchy's metadata to a file
@ -41,9 +42,9 @@ class Hierarchy(PathLike):
def __init__(self, dest):
"""Default constructor for the Hierarchy class.
>>> hier = Hierarchy('backup')
>>> hier = Hierarchy('backup_dir')
>>> hier.path
PosixPath('backup')
PosixPath('backup_dir')
:param dest: the root directory of the backup hierarchy
:type dest: str or path-like object

View File

@ -7,7 +7,6 @@ import logging
from rbackup.struct.hierarchy import Hierarchy
# ========== Logging Setup ===========
syslog = logging.getLogger(__name__)
@ -24,6 +23,7 @@ class Snapshot(Hierarchy):
Methods
-------
* gen_metadata (inherited from Hierarchy)
* read_metadata (inherited from Hierarchy)
* write_metadata (inherited from Hierarchy)
"""