From 7c070588a84aeb3ff7e665ee35eff6f3b8052235 Mon Sep 17 00:00:00 2001 From: "Eugeniy E. Mikhailov" Date: Sun, 14 Jul 2024 01:19:42 -0400 Subject: impoved doc string --- qolab/hardware/basic.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'qolab') diff --git a/qolab/hardware/basic.py b/qolab/hardware/basic.py index 1e9e920..6422002 100644 --- a/qolab/hardware/basic.py +++ b/qolab/hardware/basic.py @@ -31,11 +31,13 @@ class BasicInstrument: also used as a tag in Time Series DB (TSDB) logging. If not set we fallback to 'Device type' in config. tsdb_ingester : None or tsdb ingester - used to log properties (with setter/getter) to TSDB. If 'None', the log entry is skipped + used to log properties (with setter/getter) to TSDB. + If 'None', the log entry is skipped config : dictionary, default is empty dictionary used to add or override default entries describing instrument It is good idea to set the following keys in the dictionary: - 'Device type', 'Device model', 'DeviceId', 'DeviceNickname', 'FnamePrefix', 'SavePath'. + 'Device type', 'Device model', 'DeviceId', 'DeviceNickname', + 'FnamePrefix', 'SavePath'. Example ------- -- cgit v1.2.3