From e5dbf226762d8aa09551f941e968c6d0965ef7fa Mon Sep 17 00:00:00 2001
From: Sven Augustin <sven.augustin@psi.ch>
Date: Tue, 11 Feb 2025 21:05:42 +0100
Subject: [PATCH] re-use bsread.Source docstring for BSCache

---
 bstrd/bscache.py | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/bstrd/bscache.py b/bstrd/bscache.py
index 39d7f9f..11bb995 100644
--- a/bstrd/bscache.py
+++ b/bstrd/bscache.py
@@ -1,4 +1,4 @@
-from bsread import source, dispatcher
+from bsread import dispatcher, source, Source
 from bsread import BIND, CONNECT, PUSH, PULL, PUB, SUB # make these easier to access
 
 from .bsvar import BSVar
@@ -130,6 +130,14 @@ class BSCache:
 
 
 
+BSCache.__doc__ = f"""
+maxsize: Size of the queue between main and receiving thread.
+
+kwargs are forwarded to bsread.source:{Source.__init__.__doc__}
+"""
+
+
+
 def check_availability(name):
     if not is_available(name):
         raise ValueError(f"channel {name} is not available")