Update descriptions

src/Correction/dssc_correction.py

@@ -69,18 +69,18 @@ class DsscCorrection(calibrationBase.CalibrationReceiverBaseDevice):
             .key("askConnectedReadersToSendMySources")
             .displayedName("Request sources from connected RunToPipe")
             .description(
-                "Only relevant for development environment. When running "
-                "without a CAL_MANAGER, we need to tell RunToPipe instances "
-                "which sources to send us."
+                "Only relevant for development environment. When running without a "
+                "CAL_MANAGER, we need to tell RunToPipe instances which sources to "
+                "send us."
             )
             .commit(),
             BOOL_ELEMENT(expected)
             .key("doAnything")
             .displayedName("Enable input processing")
             .description(
-                "Toggle handling of input (at all). If False, the input "
-                "handler of this device will be skipped. Useful to decrease "
-                "logspam if device is misconfigured."
+                "Toggle handling of input (at all). If False, the input handler of "
+                "this device will be skipped. Useful to decrease logspam if device is "
+                "misconfigured."
             )
             .assignmentOptional()
             .defaultValue(True)
@@ -90,10 +90,11 @@ class DsscCorrection(calibrationBase.CalibrationReceiverBaseDevice):
             .key("applyCorrection")
             .displayedName("Enable correction(s)")
             .description(
-                "Toggle whether or not correction(s) are applied to image data. "
-                "If false, this device still reshapes data to output shape, "
-                "applies the pulse filter, and casts to output dtype. Useful for "
-                "inspecting the raw data in the same format as corrected data."
+                "Toggle whether not correction(s) are applied to image data. If "
+                "false, this device still reshapes data to output shape, applies the "
+                "pulse filter, and casts to output dtype. Useful if constants are "
+                "missing / bad, or if data is sent to application doing its own "
+                "correction."
             )
             .assignmentOptional()
             .defaultValue(True)
@@ -106,10 +107,8 @@ class DsscCorrection(calibrationBase.CalibrationReceiverBaseDevice):
             .key("fastSources")
             .displayedName("Fast data sources")
             .description(
-                "Sources to fast data as provided in channel metadata. "
-                "Provide in the form source@path.in.hash to identify both source "
-                "and path in the source data hash.\n"
-                "Currently ignores the path.in.hash part (for hardcoded image.data)"
+                "Sources to get data from. Only incoming hashes from these sources "
+                "will be processed."
             )
             .assignmentMandatory()
             .commit(),
@@ -117,11 +116,10 @@ class DsscCorrection(calibrationBase.CalibrationReceiverBaseDevice):
             .key("pulseFilter")
             .displayedName("Pulse filter")
             .description(
-                "Filter pulses: will be evaluated as array of indices to keep from data. "
-                "Can be anything which can be turned into numpy uint16 array. "
-                "Numpy is available as np. "
-                "Take care not to include duplicates. "
-                "If empty, will not filter at all."
+                "Filter pulses: will be evaluated as array of indices to keep from "
+                "data. Can be anything which can be turned into numpy uint16 array. "
+                "Numpy is available as np. Take care not to include duplicates. If "
+                "empty, will not filter at all."
             )
             .assignmentOptional()
             .defaultValue("")
@@ -131,10 +129,9 @@ class DsscCorrection(calibrationBase.CalibrationReceiverBaseDevice):
             .key("outputShmemBufferLength")
             .displayedName("Output buffer length")
             .description(
-                "Corrected trains are written to shared memory locations. "
-                "These are pre-allocated and re-used. This parameter "
-                "determines how big (number of trains) the circular buffer "
-                "will be."
+                "Corrected trains are written to shared memory locations. These are "
+                "pre-allocated and re-used. This parameter determines how big (number "
+                "of trains) the circular buffer will be."
             )
             .assignmentOptional()
             .defaultValue(50)
@@ -200,9 +197,9 @@ class DsscCorrection(calibrationBase.CalibrationReceiverBaseDevice):
             .key("dataFormat.inputDataShape")
             .displayedName("Input data shape")
             .description(
-                "Image data shape in incoming data (from reader / DAQ). "
-                "Value computed from pixelsX, pixelsY, and memoryCells - "
-                "this slot is just showing you what is currently expected."
+                "Image data shape in incoming data (from reader / DAQ). This value is "
+                "computed from pixelsX, pixelsY, and memoryCells - this field just "
+                "shows you what is currently expected."
             )
             .readOnly()
             .initialValue([])
@@ -211,9 +208,9 @@ class DsscCorrection(calibrationBase.CalibrationReceiverBaseDevice):
             .key("dataFormat.outputDataShape")
             .displayedName("Output data shape")
             .description(
-                "Image data shape for data output from this device. "
-                "Value computed from pixelsX, pixelsY, and the size of the pulse filter - "
-                "this slot is just showing what is currently expected."
+                "Image data shape for data output from this device. This value is "
+                "computed from pixelsX, pixelsY, and the size of the pulse filter - "
+                "this field just shows what is currently expected."
             )
             .readOnly()
             .initialValue([])
@@ -245,14 +242,14 @@ class DsscCorrection(calibrationBase.CalibrationReceiverBaseDevice):
             .displayedName("Pulse (or stat) for preview")
             .description(
                 "If this value is ≥ 0, the corresponding index from data will be "
-                "sliced for the preview. If this value is ≤ 0, preview will be one "
-                "of the following stats:\n"
-                "-1: max\n"
-                "-2: mean\n"
-                "-3: sum\n"
-                "-4: stdev\n"
-                "Max means selecting the pulse with the maximum integrated value. "
-                "The others are computed across all filtered pulses in the train."
+                "sliced for the preview. If this value is ≤ 0, preview will be one of "
+                "the following stats:"
+                "-1: max, "
+                "-2: mean, "
+                "-3: sum, "
+                "-4: stdev. "
+                "Max means selecting the pulse with the maximum integrated value. The "
+                "others are computed across all filtered pulses in the train."
             )
             .assignmentOptional()
             .defaultValue(0)
@@ -262,10 +259,10 @@ class DsscCorrection(calibrationBase.CalibrationReceiverBaseDevice):
             .key("preview.trainIdModulo")
             .displayedName("Train modulo for throttling")
             .description(
-                "Preview will only be sent for trains whose ID modulo this number "
-                "is zero. Higher values means fewer preview updates. Should be "
-                "adjusted based on input rate. Keep in mind that the GUI has "
-                "limited refresh rate anyway and that network is precious."
+                "Preview will only be generated for trains whose ID modulo this "
+                "number is zero. Higher values means fewer preview updates. Should be "
+                "adjusted based on input rate. Keep in mind that the GUI has limited "
+                "refresh rate anyway and that network is precious."
             )
             .assignmentOptional()
             .defaultValue(6)
@@ -282,8 +279,8 @@ class DsscCorrection(calibrationBase.CalibrationReceiverBaseDevice):
             .key("performance.rateUpdateInterval")
             .displayedName("Rate update interval")
             .description(
-                "Maximum interval (seconds) between updates of the rate. "
-                "Mostly relevant if not rateUpdateOnEachInput or if input is slow."
+                "Maximum interval (seconds) between updates of the rate. Mostly "
+                "relevant if not rateUpdateOnEachInput or if input is slow."
             )
             .assignmentOptional()
             .defaultValue(1)
@@ -301,10 +298,10 @@ class DsscCorrection(calibrationBase.CalibrationReceiverBaseDevice):
             .key("performance.rateUpdateOnEachInput")
             .displayedName("Update rate on each input")
             .description(
-                "Whether or not to update the device rate for each input "
-                "(otherwise only based on rateUpdateInterval). "
-                "Note that processed trains are always registered - this just "
-                "impacts when the rate is computed based on this."
+                "Whether or not to update the device rate for each input (otherwise "
+                "only based on rateUpdateInterval). Note that processed trains are "
+                "always registered - this just impacts when the rate is computed "
+                "based on this."
             )
             .assignmentOptional()
             .defaultValue(False)
@@ -332,8 +329,8 @@ class DsscCorrection(calibrationBase.CalibrationReceiverBaseDevice):
             .key("performance.lastProcessingDuration")
             .displayedName("Processing time")
             .description(
-                "Amount of time spent in processing latest train. "
-                "Time includes generating preview and sending data."
+                "Amount of time spent in processing latest train. Time includes "
+                "generating preview and sending data."
             )
             .unit(Unit.SECOND)
             .metricPrefix(MetricPrefix.MILLI)