From fa1f94f14ddd3925c6a8acfd012440810e5d3411 Mon Sep 17 00:00:00 2001 From: Christophe Caltagirone Date: Fri, 6 Jan 2023 17:56:42 -0600 Subject: [PATCH 1/2] Add documentation for the data rate level enumerated type. --- src/flexlogger/automation/_data_rate_level.py | 22 ++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/src/flexlogger/automation/_data_rate_level.py b/src/flexlogger/automation/_data_rate_level.py index 581fa49..3cb8582 100644 --- a/src/flexlogger/automation/_data_rate_level.py +++ b/src/flexlogger/automation/_data_rate_level.py @@ -2,11 +2,31 @@ class DataRateLevel(Enum): - """An enumeration describing the possible data rate levels.""" + """An enumeration describing the possible data rate levels that channels can be configured to use. + For additional information on configuring data rates, visit + https://www.ni.com/docs/en-US/bundle/flexlogger/page/configuring-data-rates.html + """ SLOW = 1 + """The slow analog data rate level in Hertz at which your DAQ device acquires data. + """ + MEDIUM = 2 + """The medium analog data rate level in Hertz at which your DAQ device acquires data. + """ + FAST = 3 + """The fast analog data rate level in Hertz at which your DAQ device acquires data. + """ + COUNTER = 4 + """The counter data rate level in Hertz at which your DAQ device acquires data. + """ + DIGITAL = 6 + """The digital data rate level in Hertz at which your DAQ device acquires data. + """ + ON_DEMAND = 7 + """The on-demand data rate level in Hertz at which your DAQ device acquires data. + """ From b370f7e81b9a364668dee80b978bebd6a40f7bbd Mon Sep 17 00:00:00 2001 From: Christophe Caltagirone Date: Mon, 9 Jan 2023 14:32:36 -0600 Subject: [PATCH 2/2] Remove the new line on the docstrings. --- src/flexlogger/automation/_data_rate_level.py | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/src/flexlogger/automation/_data_rate_level.py b/src/flexlogger/automation/_data_rate_level.py index 3cb8582..c17910f 100644 --- a/src/flexlogger/automation/_data_rate_level.py +++ b/src/flexlogger/automation/_data_rate_level.py @@ -8,25 +8,19 @@ class DataRateLevel(Enum): """ SLOW = 1 - """The slow analog data rate level in Hertz at which your DAQ device acquires data. - """ + """The slow analog data rate level in Hertz at which your DAQ device acquires data.""" MEDIUM = 2 - """The medium analog data rate level in Hertz at which your DAQ device acquires data. - """ + """The medium analog data rate level in Hertz at which your DAQ device acquires data.""" FAST = 3 - """The fast analog data rate level in Hertz at which your DAQ device acquires data. - """ + """The fast analog data rate level in Hertz at which your DAQ device acquires data.""" COUNTER = 4 - """The counter data rate level in Hertz at which your DAQ device acquires data. - """ + """The counter data rate level in Hertz at which your DAQ device acquires data.""" DIGITAL = 6 - """The digital data rate level in Hertz at which your DAQ device acquires data. - """ + """The digital data rate level in Hertz at which your DAQ device acquires data.""" ON_DEMAND = 7 - """The on-demand data rate level in Hertz at which your DAQ device acquires data. - """ + """The on-demand data rate level in Hertz at which your DAQ device acquires data."""