impoved doc string

1 files changed, 24 insertions, 4 deletions

diff --git a/qolab/hardware/scope/sds1104x.py b/qolab/hardware/scope/sds1104x.py
index e7dde5b..e84a405 100644
--- a/qolab/hardware/scope/sds1104x.py
+++ b/qolab/hardware/scope/sds1104x.py
@@ -81,10 +81,30 @@ class SDS1104X(ScopeSCPI):
         self, chNum, availableNpnts=None, maxRequiredPoints=None, decimate=True
     ):
         """
-        If decimate=True is used, we get all available points and then low-pass filter them.
-          The result is less noisy. But transfer time from the instrument is longer.
-        If decimate=False, then it we are skipping points to get needed number
-          but we might see aliasing, if there is a high frequency noise and sparsing > 1
+        Get raw channel waveform in binary format.
+
+        Parameters:
+        ----------
+        chNum : int
+            Scope channel to use: 1, 2, 3, or 4
+        availableNpnts : int or None (default)
+            Available numnber of points. Do not set it if you want it auto detected.
+        maxRequiredPoints : int
+            Maximum number of required points, if we ask less than available
+            we well get sparse set which proportionally fills all available time range.
+        decimate : False or True (default)
+            Decimate should be read as apply the low pass filter or not, technically
+            for both setting we get decimation (i.e. smaller than available
+            at the scope number of points). The name came from
+            ``scipy.signal.decimate`` filtering function.
+            If ``decimate=True`` is used, we get all available points
+            and then low-pass filter them to get ``maxRequiredPoints``
+            The result is less noisy then, but transfer time from the instrument
+            is longer.
+            If ``decimate=False``, then it we are skipping points to get needed number
+            but we might see aliasing, if there is a high frequency noise
+            and sparing > 1. Unless you know what you doing, it is recommended
+            to use ``decimate=True``.
         """
 
         (