Update get_tags method documentation to clarify behavior of clearing unused tags
authorAdam Dullage <redacted>
Wed, 15 May 2024 07:24:16 +0000 (08:24 +0100)
committerAdam Dullage <redacted>
Wed, 15 May 2024 07:24:16 +0000 (08:24 +0100)
server/notes/file_system/file_system.py

index 5f07776980d1d8d7e5d1ce959fbdb6a6a997f753..9655e7bf0f1f2629833117dc23b192e177f9516d 100644 (file)
@@ -145,7 +145,8 @@ class FileSystemNotes(BaseNotes):
             return tuple(self._search_result_from_hit(hit) for hit in results)\r
 \r
     def get_tags(self) -> list[str]:\r
-        """Return a list of all indexed tags."""\r
+        """Return a list of all indexed tags. Note: Tags no longer in use will\r
+        only be cleared when the index is next optimized."""\r
         self._sync_index()\r
         with self.index.reader() as reader:\r
             tags = reader.field_terms("tags")\r
git clone https://git.99rst.org/PROJECT