aboutsummaryrefslogtreecommitdiff
path: root/qolab
diff options
context:
space:
mode:
authorEugeniy E. Mikhailov <evgmik@gmail.com>2024-07-16 15:18:38 -0400
committerEugeniy E. Mikhailov <evgmik@gmail.com>2024-07-16 15:18:38 -0400
commitbac0b670dec4d5fe998f4029c6314f3c7de8ea7e (patch)
tree21e823bf99e0bb88c23783b37b7f18c5f94db6d2 /qolab
parent9d912dfb653af822369a3bc28bb5fd050a497544 (diff)
downloadqolab-bac0b670dec4d5fe998f4029c6314f3c7de8ea7e.tar.gz
qolab-bac0b670dec4d5fe998f4029c6314f3c7de8ea7e.zip
doc string improvement
Diffstat (limited to 'qolab')
-rw-r--r--qolab/hardware/basic.py12
1 files changed, 6 insertions, 6 deletions
diff --git a/qolab/hardware/basic.py b/qolab/hardware/basic.py
index e951532..5ce0859 100644
--- a/qolab/hardware/basic.py
+++ b/qolab/hardware/basic.py
@@ -9,19 +9,19 @@ class BasicInstrument:
It is intended to be used as a parent class for real instruments.
- Notable feature that when 'getConfig' is called,
- it gathers values of the properties listed in 'deviceProperties' variable and
- also if 'numberOfChannels' is set, it gathers configs of channels listed in
- 'channelProperties'. The later case is intended for instruments with
+ Notable feature that when ``getConfig`` is called,
+ it gathers values of the properties listed in ``deviceProperties`` variable and
+ also if ``numberOfChannels`` is set, it gathers configs of channels listed in
+ ``channelProperties``. The later case is intended for instruments with
global setting and channels, for example scopes. This is super handy
to include together with acquired and saved data to see under which condition
they are taken.
- Some property might have 'tsdb_append' decorator
+ Some property might have ``tsdb_append`` decorator
which sends the property value to the time
series database (TSDB) for the log keeping. Use it only for properties
which are scalar, for example VoltsPerDiv, SampleRate, and similar.
- Such logs could be later analysed with a help of systems like Grafana
+ Such logs could be later analyzed with a help of systems like Grafana
or anything which could read TSDB entries.
Parameters