From f20f77836f9d4fdad56b364da22d994fc37a9851 Mon Sep 17 00:00:00 2001
From: Eric Torres <erictorres4@protonmail.com>
Date: Mon, 22 Apr 2019 10:43:26 -0700
Subject: [PATCH] Explain what happens to snapshot_symlink when snapshot is
 deleted

---
 rbackup/struct/repository.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/rbackup/struct/repository.py b/rbackup/struct/repository.py
index 45ce7b9..f2c14a5 100644
--- a/rbackup/struct/repository.py
+++ b/rbackup/struct/repository.py
@@ -109,6 +109,10 @@ class Repository(Hierarchy):
         and snapshot metadata are in the same order, and that
         the two lists are the same size.
 
+        When a snapshot is deleted, then the symlink of the repository
+        is pointed to the snapshot at the end of the list. If no
+        snapshots remain, then that symlink is deleted instead.
+
         :param index: index of snapshot to delete
         :type index: int
         """