Skip to content

Commit b4ac548

Browse files
committed
fix: doc-strings
Signed-off-by: Felix Zwettler <felix.zwettler@duagon.com>
1 parent 76a0b1e commit b4ac548

File tree

1 file changed

+6
-21
lines changed

1 file changed

+6
-21
lines changed

labgrid/driver/sigrokdriver.py

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -202,13 +202,8 @@ def capture_for_time(self, filename, time_ms, samplerate="200k"):
202202
samplerate: the sample-rate of the capture
203203
204204
Returns:
205-
The capture as a list containing dict's with fields:
206-
{
207-
"time": sample time (us),
208-
"channel_name_1": Sample value for channel 1,
209-
"channel_name_2": Sample value for channel 2,
210-
...
211-
}
205+
The capture as a list containing dict's with fields "Time"
206+
and the channel names
212207
213208
Raises:
214209
OSError() if the subprocess returned with non-zero return-code
@@ -228,13 +223,8 @@ def capture_samples(self, filename, samples, samplerate="200k"):
228223
samplerate: the sample-rate of the capture
229224
230225
Returns:
231-
The capture as a list containing dict's with fields:
232-
{
233-
"time": sample time (us),
234-
"channel_name_1": Sample value for channel 1,
235-
"channel_name_2": Sample value for channel 2,
236-
...
237-
}
226+
The capture as a list containing dict's with fields "Time"
227+
and the channel names
238228
"""
239229
return self._capture_blocking(filename, ["--samples", str(samples)], samplerate)
240230

@@ -248,13 +238,8 @@ def stop(self):
248238
containing the samples.
249239
250240
Returns:
251-
The capture as a list containing dict's with fields:
252-
{
253-
"time": sample time (us),
254-
"channel_name_1": Sample value for channel 1,
255-
"channel_name_2": Sample value for channel 2,
256-
...
257-
}
241+
The capture as a list containing dict's with fields "Time"
242+
and the channel names
258243
259244
Raises:
260245
RuntimeError() if capture has not been started

0 commit comments

Comments
 (0)