From 4c6d9bee25a2a31922fef64e722d3bd93f0e768b Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Tue, 22 Aug 2023 12:29:19 +0200
Subject: [PATCH] DOC: More docs for caching.
---
src/caosdb/cached.py | 8 ++++++++
src/caosdb/high_level_api.py | 2 +-
2 files changed, 9 insertions(+), 1 deletion(-)
diff --git a/src/caosdb/cached.py b/src/caosdb/cached.py
index 4f735bb8..13152667 100644
--- a/src/caosdb/cached.py
+++ b/src/caosdb/cached.py
@@ -22,6 +22,14 @@
"""
This module provides some cached versions of functions that retrieve Entities from a remote server.
+
+See also
+========
+
+- ``cache_initialize(...)`` : Re-initialize the cache.
+- ``cache_clear()`` : Clear the cache.
+- ``cached_query(query)`` : A cached version of ``execute_query(query)``.
+- ``cached_get_entity_by(...)`` : Get an Entity by name, id, ...
"""
from enum import Enum
diff --git a/src/caosdb/high_level_api.py b/src/caosdb/high_level_api.py
index 82c63fea..3509a7b6 100644
--- a/src/caosdb/high_level_api.py
+++ b/src/caosdb/high_level_api.py
@@ -49,7 +49,7 @@ from datetime import datetime
from dateutil import parser
warnings.warn("""EXPERIMENTAL! The high_level_api module is experimental and may be changed or
-removed in future. Its purpose is to give an impression on how the Python client user interface
+removed in the future. Its purpose is to give an impression on how the Python client user interface
might be changed.""")
--
GitLab