Skip to content

Commit a223b1e

Browse files
committed
handwritten: Fix D411 Missing blank line before section
1 parent 3310117 commit a223b1e

24 files changed

+66
-2
lines changed

src/handwritten/_bitfield_utils.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ def enum_bitfield_to_list(bitfield_value, bitfield_enum_type, actual_enum_type):
66
bitfield_enum_type (enum.Enum): Specifies the bitfield enum type
77
from which to mask and extract the enum values.
88
actual_enum_type (enum.Enum): Specifies the actual enum type.
9+
910
Returns:
1011
List[enum.Enum]: Indicates the converted list of enums.
1112
"""
@@ -25,6 +26,7 @@ def enum_list_to_bitfield(enum_list, bitfield_enum_type):
2526
enum_list (List[enum.Enum]): Specifies the list of enums.
2627
bitfield_enum_type (enum.Enum): Specifies the bitfield enum type
2728
from which to mask and extract the enum values.
29+
2830
Returns:
2931
int: Indicates the value of the bitfield.
3032
"""

src/handwritten/grpc_session_options.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ def __init__(
5555
api_key=MEASUREMENTLINK_23Q1_NIDAQMX_PYTHON_API_KEY,
5656
initialization_behavior=SessionInitializationBehavior.AUTO,
5757
):
58-
r"""Collection of options that specifies session behaviors related to gRPC.
59-
Creates and returns an object you can pass to a Session constructor.
58+
"""Initialize a new GrpcSessionOptions.
59+
6060
Args:
6161
grpc_channel (grpc.Channel): Specifies the channel to the NI gRPC Device Server.
6262
session_name (str): User-specified name that identifies the driver session on the NI gRPC Device

src/handwritten/stream_readers/_analog_multi_channel_reader.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ def read_many_sample(
8080
indefinitely. If you set timeout to 0, the method tries
8181
once to read the requested samples and returns an error
8282
if it is unable to.
83+
8384
Returns:
8485
int:
8586
@@ -195,6 +196,7 @@ def read_waveforms(
195196
indefinitely. If you set timeout to 0, the method tries
196197
once to read the requested samples and returns an error
197198
if it is unable to.
199+
198200
Returns:
199201
int:
200202

src/handwritten/stream_readers/_analog_single_channel_reader.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ def read_many_sample(
6666
indefinitely. If you set timeout to 0, the method tries
6767
once to read the requested samples and returns an error
6868
if it is unable to.
69+
6970
Returns:
7071
int:
7172
@@ -103,6 +104,7 @@ def read_one_sample(self, timeout=10):
103104
indefinitely. If you set timeout to 0, the method tries
104105
once to read the requested samples and returns an error
105106
if it is unable to.
107+
106108
Returns:
107109
float:
108110
@@ -164,6 +166,7 @@ def read_waveform(
164166
indefinitely. If you set timeout to 0, the method tries
165167
once to read the requested samples and returns an error
166168
if it is unable to.
169+
167170
Returns:
168171
int:
169172

src/handwritten/stream_readers/_analog_unscaled_reader.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ def read_int16(self, data, number_of_samples_per_channel=READ_ALL_AVAILABLE, tim
7272
indefinitely. If you set timeout to 0, the method tries
7373
once to read the requested samples and returns an error
7474
if it is unable to.
75+
7576
Returns:
7677
int:
7778
@@ -158,6 +159,7 @@ def read_int32(self, data, number_of_samples_per_channel=READ_ALL_AVAILABLE, tim
158159
indefinitely. If you set timeout to 0, the method tries
159160
once to read the requested samples and returns an error
160161
if it is unable to.
162+
161163
Returns:
162164
int:
163165
@@ -244,6 +246,7 @@ def read_uint16(self, data, number_of_samples_per_channel=READ_ALL_AVAILABLE, ti
244246
indefinitely. If you set timeout to 0, the method tries
245247
once to read the requested samples and returns an error
246248
if it is unable to.
249+
247250
Returns:
248251
int:
249252
@@ -330,6 +333,7 @@ def read_uint32(self, data, number_of_samples_per_channel=READ_ALL_AVAILABLE, ti
330333
indefinitely. If you set timeout to 0, the method tries
331334
once to read the requested samples and returns an error
332335
if it is unable to.
336+
333337
Returns:
334338
int:
335339

src/handwritten/stream_readers/_counter_reader.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ def read_many_sample_double(
6161
indefinitely. If you set timeout to 0, the method tries
6262
once to read the requested samples and returns an error
6363
if it is unable to.
64+
6465
Returns:
6566
int:
6667
@@ -148,6 +149,7 @@ def read_many_sample_pulse_frequency(
148149
indefinitely. If you set timeout to 0, the method tries
149150
once to read the requested samples and returns an error
150151
if it is unable to.
152+
151153
Returns:
152154
int:
153155
@@ -233,6 +235,7 @@ def read_many_sample_pulse_ticks(
233235
indefinitely. If you set timeout to 0, the method tries
234236
once to read the requested samples and returns an error
235237
if it is unable to.
238+
236239
Returns:
237240
int:
238241
@@ -318,6 +321,7 @@ def read_many_sample_pulse_time(
318321
indefinitely. If you set timeout to 0, the method tries
319322
once to read the requested samples and returns an error
320323
if it is unable to.
324+
321325
Returns:
322326
int:
323327
@@ -395,6 +399,7 @@ def read_many_sample_uint32(
395399
indefinitely. If you set timeout to 0, the method tries
396400
once to read the requested samples and returns an error
397401
if it is unable to.
402+
398403
Returns:
399404
int:
400405
@@ -432,6 +437,7 @@ def read_one_sample_double(self, timeout=10):
432437
indefinitely. If you set timeout to 0, the method tries
433438
once to read the requested samples and returns an error
434439
if it is unable to.
440+
435441
Returns:
436442
float: Indicates a single floating-point sample from the
437443
task.
@@ -452,6 +458,7 @@ def read_one_sample_pulse_frequency(self, timeout=10):
452458
indefinitely. If you set timeout to 0, the method tries
453459
once to read the requested samples and returns an error
454460
if it is unable to.
461+
455462
Returns:
456463
nidaqmx.types.CtrFreq:
457464
@@ -475,6 +482,7 @@ def read_one_sample_pulse_ticks(self, timeout=10):
475482
indefinitely. If you set timeout to 0, the method tries
476483
once to read the requested samples and returns an error
477484
if it is unable to.
485+
478486
Returns:
479487
nidaqmx.types.CtrTick:
480488
@@ -498,6 +506,7 @@ def read_one_sample_pulse_time(self, timeout=10):
498506
indefinitely. If you set timeout to 0, the method tries
499507
once to read the requested samples and returns an error
500508
if it is unable to.
509+
501510
Returns:
502511
nidaqmx.types.CtrTime:
503512
@@ -521,6 +530,7 @@ def read_one_sample_uint32(self, timeout=10):
521530
indefinitely. If you set timeout to 0, the method tries
522531
once to read the requested samples and returns an error
523532
if it is unable to.
533+
524534
Returns:
525535
int:
526536

src/handwritten/stream_readers/_digital_multi_channel_reader.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ def read_many_sample_port_byte(
8282
indefinitely. If you set timeout to 0, the method tries
8383
once to read the requested samples and returns an error
8484
if it is unable to.
85+
8586
Returns:
8687
int:
8788
@@ -172,6 +173,7 @@ def read_many_sample_port_uint16(
172173
indefinitely. If you set timeout to 0, the method tries
173174
once to read the requested samples and returns an error
174175
if it is unable to.
176+
175177
Returns:
176178
int:
177179
@@ -262,6 +264,7 @@ def read_many_sample_port_uint32(
262264
indefinitely. If you set timeout to 0, the method tries
263265
once to read the requested samples and returns an error
264266
if it is unable to.
267+
265268
Returns:
266269
int:
267270
@@ -538,6 +541,7 @@ def read_waveforms(
538541
indefinitely. If you set timeout to 0, the method tries
539542
once to read the requested samples and returns an error
540543
if it is unable to.
544+
541545
Returns:
542546
int:
543547

src/handwritten/stream_readers/_digital_single_channel_reader.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ def read_many_sample_port_byte(
6868
indefinitely. If you set timeout to 0, the method tries
6969
once to read the requested samples and returns an error
7070
if it is unable to.
71+
7172
Returns:
7273
int:
7374
@@ -145,6 +146,7 @@ def read_many_sample_port_uint16(
145146
indefinitely. If you set timeout to 0, the method tries
146147
once to read the requested samples and returns an error
147148
if it is unable to.
149+
148150
Returns:
149151
int:
150152
@@ -222,6 +224,7 @@ def read_many_sample_port_uint32(
222224
indefinitely. If you set timeout to 0, the method tries
223225
once to read the requested samples and returns an error
224226
if it is unable to.
227+
225228
Returns:
226229
int:
227230
@@ -297,6 +300,7 @@ def read_one_sample_one_line(self, timeout=10):
297300
indefinitely. If you set timeout to 0, the method tries
298301
once to read the requested samples and returns an error
299302
if it is unable to.
303+
300304
Returns:
301305
bool:
302306
@@ -325,6 +329,7 @@ def read_one_sample_port_byte(self, timeout=10):
325329
indefinitely. If you set timeout to 0, the method tries
326330
once to read the requested samples and returns an error
327331
if it is unable to.
332+
328333
Returns:
329334
int:
330335
@@ -354,6 +359,7 @@ def read_one_sample_port_uint16(self, timeout=10):
354359
indefinitely. If you set timeout to 0, the method tries
355360
once to read the requested samples and returns an error
356361
if it is unable to.
362+
357363
Returns:
358364
int:
359365
@@ -383,6 +389,7 @@ def read_one_sample_port_uint32(self, timeout=10):
383389
indefinitely. If you set timeout to 0, the method tries
384390
once to read the requested samples and returns an error
385391
if it is unable to.
392+
386393
Returns:
387394
int:
388395
@@ -438,6 +445,7 @@ def read_waveform(
438445
indefinitely. If you set timeout to 0, the method tries
439446
once to read the requested samples and returns an error
440447
if it is unable to.
448+
441449
Returns:
442450
int:
443451

src/handwritten/stream_readers/_power_readers.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ def read_many_sample(
7373
indefinitely. If you set timeout to 0, the method tries
7474
once to read the requested samples and returns an error
7575
if it is unable to.
76+
7677
Returns:
7778
int:
7879
@@ -112,6 +113,7 @@ def read_one_sample(self, timeout=10):
112113
indefinitely. If you set timeout to 0, the method tries
113114
once to read the requested samples and returns an error
114115
if it is unable to.
116+
115117
Returns:
116118
float:
117119
@@ -216,6 +218,7 @@ def read_many_sample(
216218
indefinitely. If you set timeout to 0, the method tries
217219
once to read the requested samples and returns an error
218220
if it is unable to.
221+
219222
Returns:
220223
int:
221224
@@ -377,6 +380,7 @@ def read_many_sample(
377380
indefinitely. If you set timeout to 0, the method tries
378381
once to read the requested samples and returns an error
379382
if it is unable to.
383+
380384
Returns:
381385
int:
382386

src/handwritten/stream_writers/_analog_multi_channel_writer.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ def write_many_sample(self, data, timeout=10.0):
4242
once to write the submitted samples. If the method could
4343
not write all the submitted samples, it returns an error
4444
and the number of samples successfully written.
45+
4546
Returns:
4647
int:
4748

0 commit comments

Comments
 (0)