Skip to content

Commit

Permalink
fix: doc-strings
Browse files Browse the repository at this point in the history
  • Loading branch information
@flxzt
flxzt committed Apr 9, 2024
1 parent 76a0b1e commit f1c31da
Showing 1 changed file with 6 additions and 21 deletions.
27 changes: 6 additions & 21 deletions labgrid/driver/sigrokdriver.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -202,13 +202,8 @@ def capture_for_time(self, filename, time_ms, samplerate="200k"):
samplerate: the sample-rate of the capture
Returns:
The capture as a list containing dict's with fields:
{
"time": sample time (us),
"channel_name_1": Sample value for channel 1,
"channel_name_2": Sample value for channel 2,
...
}
The capture as a list containing dict's with fields "Time"
and the channel names
Raises:
OSError() if the subprocess returned with non-zero return-code
Expand All @@ -228,13 +223,8 @@ def capture_samples(self, filename, samples, samplerate="200k"):
samplerate: the sample-rate of the capture
Returns:
The capture as a list containing dict's with fields:
{
"time": sample time (us),
"channel_name_1": Sample value for channel 1,
"channel_name_2": Sample value for channel 2,
...
}
The capture as a list containing dict's with fields "Time"
and the channel names
"""
return self._capture_blocking(filename, ["--samples", str(samples)], samplerate)

Expand All @@ -248,13 +238,8 @@ def stop(self):
containing the samples.
Returns:
The capture as a list containing dict's with fields:
{
"time": sample time (us),
"channel_name_1": Sample value for channel 1,
"channel_name_2": Sample value for channel 2,
...
}
The capture as a list containing dict's with fields "Time"
and the channel names
Raises:
RuntimeError() if capture has not been started
Expand Down

0 comments on commit f1c31da

Please sign in to comment.