diff --git a/rbackup/struct/hierarchy.py b/rbackup/struct/hierarchy.py index eeb4910..fcf2b26 100644 --- a/rbackup/struct/hierarchy.py +++ b/rbackup/struct/hierarchy.py @@ -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 diff --git a/rbackup/struct/snapshot.py b/rbackup/struct/snapshot.py index 5ef8a9e..fbd1a76 100644 --- a/rbackup/struct/snapshot.py +++ b/rbackup/struct/snapshot.py @@ -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) """