From: Adam Dullage <redacted>
Date: Wed, 15 May 2024 07:24:16 +0000 (+0100)
Subject: Update get_tags method documentation to clarify behavior of clearing unused tags
X-Git-Url: http://git.99rst.org/?a=commitdiff_plain;h=2159db6a4405cc3d8a60bad0e1e8290d356a49b0;p=flatnotes.git

Update get_tags method documentation to clarify behavior of clearing unused tags
---

diff --git a/server/notes/file_system/file_system.py b/server/notes/file_system/file_system.py
index 5f07776..9655e7b 100644
--- a/server/notes/file_system/file_system.py
+++ b/server/notes/file_system/file_system.py
@@ -145,7 +145,8 @@ class FileSystemNotes(BaseNotes):
             return tuple(self._search_result_from_hit(hit) for hit in results)
 
     def get_tags(self) -> list[str]:
-        """Return a list of all indexed tags."""
+        """Return a list of all indexed tags. Note: Tags no longer in use will
+        only be cleared when the index is next optimized."""
         self._sync_index()
         with self.index.reader() as reader:
             tags = reader.field_terms("tags")