Merge pull request #38697 from peterfpeterson/38610_fix_formatting_ornlnext

peterfpeterson · web-flow · commit 220c43b776d7 · 2025-01-24T17:01:46.000-05:00
Fix pre-commit formatting - ornl-next
diff --git a/Framework/PythonInterface/plugins/algorithms/BASISCrystalDiffraction.py b/Framework/PythonInterface/plugins/algorithms/BASISCrystalDiffraction.py
@@ -239,7 +239,7 @@ def PyInit(self):
         #    incoming beam
         self.declareProperty(
             FloatArrayProperty("VectorV", [0, 1, 0], array_length_three, direction=Direction.Input),
-            doc="three item, comma-separated, HKL indices of the direction perpendicular to VectorVand the vertical axis",
+            doc="three item, comma-separated, HKL indices of the direction perpendicular to VectorV and the vertical axis",
         )
         #    Abscissa view
         self.declareProperty(
diff --git a/Framework/PythonInterface/plugins/algorithms/BASISDiffraction.py b/Framework/PythonInterface/plugins/algorithms/BASISDiffraction.py
@@ -193,7 +193,7 @@ def PyInit(self):
         #    incoming beam
         self.declareProperty(
             FloatArrayProperty("VectorV", [0, 1, 0], array_length_three, direction=Direction.Input),
-            doc="three item, comma-separated, HKL indices of the direction perpendicular to VectorVand the vertical axis",
+            doc="three item, comma-separated, HKL indices of the direction perpendicular to VectorV and the vertical axis",
         )
         #    Abscissa view
         self.declareProperty(
diff --git a/Framework/PythonInterface/plugins/algorithms/ElasticEMUauReduction.py b/Framework/PythonInterface/plugins/algorithms/ElasticEMUauReduction.py
@@ -97,7 +97,7 @@ def PyInit(self) -> None:
         mandatoryInputRuns.add(StringArrayMandatoryValidator())
         self.declareProperty(
             StringArrayProperty("SampleRuns", values=[], validator=mandatoryInputRuns),
-            doc="Comma separated range of sample runs,\nand optional dataset indexes,\neg [cycle::] 7333-7341,7345[:0-23]",
+            doc="Comma separated range of sample runs, and optional dataset indexes, e.g. [cycle::] 7333-7341,7345[:0-23]",
         )
 
         self.declareProperty(
@@ -148,19 +148,19 @@ def PyInit(self) -> None:
         self.declareProperty(
             name="ScanParameter",
             defaultValue="",
-            doc="Display data for time series environment variable,\nusing optional label and units  eg T02SP06 [, Temperature, K]",
+            doc="Display data for time series environment variable, using optional label and units e.g. T02SP06 [, Temperature, K]",
         )
 
         self.declareProperty(
             name="ReferenceRange",
             defaultValue="",
-            doc="Normalise the sample counts over the environment or\ntime range. Values are in environment units or secs,\n eg 75-100",
+            doc="Normalise the sample counts over the environment or time range. Values are in environment units or secs, e.g. 75-100",
         )
 
         self.declareProperty(
             name="SteppedScanParameter",
             defaultValue=False,
-            doc="If the environment variable is set and held\nduring each scan rather than continuosly changing.",
+            doc="If the environment variable is set and held during each scan rather than continuously changing.",
         )
 
         self.declareProperty(WorkspaceProperty("OutputWorkspace", "", direction=Direction.Output), doc="Name for the reduced workspace.")
@@ -173,7 +173,7 @@ def PyInit(self) -> None:
         self.declareProperty(
             name="KeepIntermediateWorkspaces",
             defaultValue=False,
-            doc="Whether to keep the intermediate sample and calibration\nworkspaces for diagnostic checks.",
+            doc="Whether to keep the intermediate sample and calibration workspaces for diagnostic checks.",
         )
 
         self.declareProperty(
@@ -502,7 +502,7 @@ def _scan_and_reduce(self, output_ws: str, analyse_runs: Sequence[str], single_b
         stepped_env = self.getProperty("SteppedScanParameter").value
 
         # determine the pulse map function and bin parameters
-        # - if env parameter need to account for stepped or contnuous
+        # - if env parameter need to account for stepped or continuous
         # - if pulse then map to dataset index
         if single_bin:
             tsmap, bin_params = self.get_single_bin_map(anl_ws)
diff --git a/Framework/PythonInterface/plugins/algorithms/FindGoniometerFromUB.py b/Framework/PythonInterface/plugins/algorithms/FindGoniometerFromUB.py
@@ -100,7 +100,7 @@ def PyInit(self):
             defaultValue=0.0,
             direction=Direction.Input,
             validator=FloatBoundedValidator(lower=0.0, upper=180.0),
-            doc="omega rotation between component of goniometer axis in XY-plane from +ve Y-axis(perpendicular to ki)",
+            doc="omega rotation between component of goniometer axis in XY-plane from +ve Y-axis (perpendicular to ki)",
         )
         self.declareProperty(
             name="OmegaHand",
diff --git a/Framework/PythonInterface/plugins/algorithms/InelasticEMUauReduction.py b/Framework/PythonInterface/plugins/algorithms/InelasticEMUauReduction.py
@@ -137,7 +137,7 @@ def PyInit(self):
         self.declareProperty(
             name="KeepIntermediateWorkspaces",
             defaultValue=False,
-            doc="Whether to keep the intermediate sample and calibration\nworkspaces for diagnostic checks.",
+            doc="Whether to keep the intermediate sample and calibration workspaces for diagnostic checks.",
         )
 
         self.declareProperty(
diff --git a/Framework/PythonInterface/plugins/algorithms/LoadCIF.py b/Framework/PythonInterface/plugins/algorithms/LoadCIF.py
@@ -136,7 +136,7 @@ def _getUnitCell(self, cifData):
         )
 
         if unitCellValueMap["_cell_length_a"] is None:
-            raise RuntimeError("The a-parameter of the unit cell is not specified in the supplied CIF.\nKey to look for: _cell_length_a")
+            raise RuntimeError("The a-parameter of the unit cell is not specified in the supplied CIF. Key to look for: _cell_length_a")
 
         replacementMap = {
             "_cell_length_b": str(unitCellValueMap["_cell_length_a"]),
@@ -202,7 +202,7 @@ def _getAtomCoordinates(self, cifData, labels):
 
         for field in coordinateFields:
             if field not in cifData.keys():
-                raise RuntimeError("Mandatory field {0} not found in CIF-file.Please check the atomic position definitions.".format(field))
+                raise RuntimeError("Mandatory field {0} not found in CIF-file. Please check the atomic position definitions.".format(field))
 
         # Return a dict like { 'label1': 'x y z', 'label2': 'x y z' }
         return dict(
diff --git a/Framework/PythonInterface/plugins/algorithms/LoadNMoldyn4Ascii1D.py b/Framework/PythonInterface/plugins/algorithms/LoadNMoldyn4Ascii1D.py
@@ -28,7 +28,7 @@ def category(self):
         return "Simulation; Inelastic\\DataHandling"
 
     def summary(self):
-        return "Imports 1D dos and vac functions from an nMolDyn 4 output file,convoluting it with a resolution function if required."
+        return "Imports 1D dos and vac functions from an nMolDyn 4 output file, convoluting it with a resolution function if required."
 
     def PyInit(self):
         self.declareProperty(FileProperty("Directory", "", action=FileAction.Directory), doc=("Path to directory containing dat files"))
diff --git a/Framework/PythonInterface/plugins/algorithms/PelicanReduction.py b/Framework/PythonInterface/plugins/algorithms/PelicanReduction.py
@@ -98,27 +98,27 @@ def PyInit(self) -> None:
         mandatoryInputRuns.add(StringArrayMandatoryValidator())
         self.declareProperty(
             StringArrayProperty("SampleRuns", values=[], validator=mandatoryInputRuns),
-            doc="Optional cycle number followed by comma separated range of\nsample runs as [cycle::] n1,n2,..\n eg 123::7333-7341,7345",
+            doc="Optional cycle number followed by comma separated range of sample runs as [cycle::] n1,n2,.. e.g. 123::7333-7341,7345",
         )
 
         self.declareProperty(
             name="EmptyRuns",
             defaultValue="",
-            doc="Optional cycle number followed by comma separated range of\nruns as [cycle::] n1,n2,..\n  eg 123::6300-6308",
+            doc="Optional cycle number followed by comma separated range of runs as [cycle::] n1,n2,.. e.g. 123::6300-6308",
         )
 
         self.declareProperty(name="ScaleEmptyRuns", defaultValue=1.0, doc="Scale the empty runs prior to subtraction")
 
         self.declareProperty(
             name="CalibrationRuns",
             defaultValue="",
-            doc="Optional cycle number followed by comma separated range of\nruns as [cycle::] n1,n2,..\n  eg 123::6350-6365",
+            doc="Optional cycle number followed by comma separated range of runs as [cycle::] n1,n2,.. e.g. 123::6350-6365",
         )
 
         self.declareProperty(
             name="EmptyCalibrationRuns",
             defaultValue="",
-            doc="Optional cycle number followed by comma separated range of\nruns as [cycle::] n1,n2,..\n  eg 123::6370-6375",
+            doc="Optional cycle number followed by comma separated range of runs as [cycle::] n1,n2,.. e.g. 123::6370-6375",
         )
 
         self.declareProperty(
@@ -137,7 +137,7 @@ def PyInit(self) -> None:
             name="Processing",
             defaultValue="SOFQW1-Centre",
             validator=StringListValidator(["SOFQW1-Centre", "SOFQW3-NormalisedPolygon", "NXSPE"]),
-            doc="Convert to SOFQW or save file as NXSPE,\nnote SOFQW3 is more accurate but much slower than SOFQW1.",
+            doc="Convert to SOFQW or save file as NXSPE, note SOFQW3 is more accurate but much slower than SOFQW1.",
         )
 
         self.declareProperty(name="LambdaOnTwoMode", defaultValue=False, doc="Set if instrument running in lambda on two mode.")
@@ -162,7 +162,7 @@ def PyInit(self) -> None:
         self.declareProperty(
             name="KeepIntermediateWorkspaces",
             defaultValue=False,
-            doc="Whether to keep the intermediate sample and calibration\nworkspaces for diagnostic checks.",
+            doc="Whether to keep the intermediate sample and calibration workspaces for diagnostic checks.",
         )
 
         self.declareProperty(
diff --git a/Framework/PythonInterface/plugins/algorithms/PoldiMerge.py b/Framework/PythonInterface/plugins/algorithms/PoldiMerge.py
@@ -38,7 +38,7 @@ def PyInit(self):
         self.declareProperty(
             "CheckInstruments",
             True,
-            "If checked, only workspaces with equal instrument parameters are merged.Do not disable without a very good reason.",
+            "If checked, only workspaces with equal instrument parameters are merged. Do not disable without a very good reason.",
         )
 
     def PyExec(self):
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectILLReductionQENS.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/IndirectILLReductionQENS.py
@@ -270,7 +270,7 @@ def _filter_files(self, files, label):
         files = SelectNexusFilesByMetadata(files, self._criteria)
 
         if not files:
-            raise RuntimeError("None of the {0} runs are of QENS type.Check the files or reduction type.".format(label))
+            raise RuntimeError("None of the {0} runs are of QENS type. Check the files or reduction type.".format(label))
         else:
             self.log().information("Filtered {0} runs are: {1} \\n".format(label, files.replace(",", "\\n")))
 
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/PolDiffILLReduction.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/PolDiffILLReduction.py
@@ -378,7 +378,7 @@ def PyInit(self):
         self.declareProperty(
             name="MaxTOFChannel",
             defaultValue=512,
-            doc="What is the maximal number of TOF bins to be used.Bins above this value will be removed.",
+            doc="What is the maximal number of TOF bins to be used. Bins above this value will be removed.",
         )
 
         self.setPropertySettings("MaxTOFChannel", tofMeasurement)
@@ -1332,7 +1332,7 @@ def _calculate_attenuation_factors(self, sample_ws):
         return attenuation_ws
 
     def _apply_self_attenuation_correction(self, sample_ws, empty_ws):
-        """Applies the self-attenuation correction based on the Palmaan-Pings Monte-Carlo calculation, taking into account
+        """Applies the self-attenuation correction based on the Paalman-Pings Monte-Carlo calculation, taking into account
         the sample's material, shape, and dimensions."""
 
         attenuation_method = self.getPropertyValue("SelfAttenuationMethod")
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ReflectometryILLPreprocess.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ReflectometryILLPreprocess.py
@@ -242,7 +242,7 @@ def validateInputs(self):
 
         if self.getProperty(Prop.BKG_METHOD).value != BkgMethod.OFF:
             if self.getProperty(Prop.LOW_BKG_WIDTH).value == 0 and self.getProperty(Prop.HIGH_BKG_WIDTH).value == 0:
-                issues[Prop.BKG_METHOD] = "Cannot calculate flat background if both upper and lower background / widths are zero."
+                issues[Prop.BKG_METHOD] = "Cannot calculate flat background if both upper and lower background widths are zero."
         # Early input validation to prevent FindReflectometryLines to fail its validation
         if not self.getProperty(Prop.XMIN).isDefault and not self.getProperty(Prop.XMAX).isDefault:
             x_min = self.getProperty(Prop.XMIN).value
diff --git a/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/SavePlot1D.py b/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/SavePlot1D.py
@@ -48,7 +48,7 @@ def PyInit(self):
         self.declareProperty(StringArrayProperty("SpectraNames", [], direction=Direction.Input), "Override with custom names for spectra")
         self.declareProperty("Result", "", Direction.Output)
 
-        self.declareProperty("PopCanvas", False, "If true, a Matplotlib canvas will be popped out , which contains the saved plot.")
+        self.declareProperty("PopCanvas", False, "If true, a Matplotlib canvas will be popped out, which contains the saved plot.")
 
     def validateInputs(self):
         messages = {}
diff --git a/Framework/PythonInterface/test/python/plugins/algorithms/SaveGSSCWTest.py b/Framework/PythonInterface/test/python/plugins/algorithms/SaveGSSCWTest.py
@@ -139,9 +139,9 @@ def check_gsas(self, filename, expected_data):
         for li, line in enumerate(contents):
             # readlines() will keep the line-change sign
             if len(line) == 81:
-                assert line[-1] == "\n", f"Line {li}: {line} contains {len(line)} characters but not 80.Its last character is [{line[-1]}]"
+                assert line[-1] == "\n", f"Line {li}: {line} contains {len(line)} characters but not 80. Its last character is [{line[-1]}]"
             else:
-                assert len(line) == 80, f"Line {li}: {line} contains {len(line)} characters but not 80.Its last character is [{line[-1]}]"
+                assert len(line) == 80, f"Line {li}: {line} contains {len(line)} characters but not 80. Its last character is [{line[-1]}]"
 
         # line 0 is emtpy
         assert contents[0].strip() == "", "First line must be empty but not >{}<".format(contents[0].strip())
diff --git a/docs/source/algorithms/AddAbsorptionWeightedPathLengths-v1.rst b/docs/source/algorithms/AddAbsorptionWeightedPathLengths-v1.rst
@@ -67,7 +67,7 @@ The algorithm for calculating the attenuation factor A proceeds as follows. For
 
    * accumulate this wavelength-specific factor across all `NEvents`
 
-#. average the accumulated attentuation factors over `NEvents` and assign this as the correction factor for
+#. average the accumulated attenuation factors over `NEvents` and assign this as the correction factor for
    this :math:`\lambda`.
 
 
diff --git a/qt/applications/workbench/workbench/widgets/plotselector/view.py b/qt/applications/workbench/workbench/widgets/plotselector/view.py
@@ -162,7 +162,7 @@ def _make_table_widget(self):
         """
         Make a table showing the matplotlib figure number of the
         plots, the name with close and edit buttons, and a hidden
-        column for sorting with the last actuve order
+        column for sorting with the last active order
         :return: A QTableWidget object which will contain plot widgets
         """
         table_widget = QTableWidget(0, 3, self)
@@ -179,7 +179,7 @@ def _make_table_widget(self):
             "number, to get a handle to the plot."
         )
 
-        table_widget.horizontalHeaderItem(Column.Name).setToolTip("The plot name, also used  as the file name when saving multiple plots.")
+        table_widget.horizontalHeaderItem(Column.Name).setToolTip("The plot name, also used as the file name when saving multiple plots.")
 
         table_widget.setSelectionBehavior(QAbstractItemView.SelectRows)
         table_widget.setSelectionMode(QAbstractItemView.ExtendedSelection)
diff --git a/qt/python/mantidqtinterfaces/mantidqtinterfaces/simplescanviewer/presenter.py b/qt/python/mantidqtinterfaces/mantidqtinterfaces/simplescanviewer/presenter.py
@@ -87,7 +87,7 @@ def additional_peaks_info(self, rectangles: list) -> dict:
             peak_dict["I (bg corrected)"] = corrected_roi_integrations
 
             if np.any(self._bg_ws.getAxis(0).extractValues() != self._ws.getAxis(0).extractValues()):
-                logger.warning("Background and sample data have different two theta ranges.Please check that these data match.")
+                logger.warning("Background and sample data have different two theta ranges. Please check that these data match.")
 
             if len(self._bg_ws.getAxis(1)) > 1:
                 logger.warning("Background has more than one slice. Only the first one is considered for background subtraction.")

Original file line number	Diff line number	Diff line change
`@@ -239,7 +239,7 @@ def PyInit(self):`
`239`	`239`	`# incoming beam`
`240`	`240`	`self.declareProperty(`
`241`	`241`	`FloatArrayProperty("VectorV", [0, 1, 0], array_length_three, direction=Direction.Input),`
`242`		`- doc="three item, comma-separated, HKL indices of the direction perpendicular to VectorVand the vertical axis",`
	`242`	`+ doc="three item, comma-separated, HKL indices of the direction perpendicular to VectorV and the vertical axis",`
`243`	`243`	`)`
`244`	`244`	`# Abscissa view`
`245`	`245`	`self.declareProperty(`
Original file line number	Diff line number	Diff line change
`@@ -193,7 +193,7 @@ def PyInit(self):`
`193`	`193`	`# incoming beam`
`194`	`194`	`self.declareProperty(`
`195`	`195`	`FloatArrayProperty("VectorV", [0, 1, 0], array_length_three, direction=Direction.Input),`
`196`		`- doc="three item, comma-separated, HKL indices of the direction perpendicular to VectorVand the vertical axis",`
	`196`	`+ doc="three item, comma-separated, HKL indices of the direction perpendicular to VectorV and the vertical axis",`
`197`	`197`	`)`
`198`	`198`	`# Abscissa view`
`199`	`199`	`self.declareProperty(`
Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ def PyInit(self):`
`100`	`100`	`defaultValue=0.0,`
`101`	`101`	`direction=Direction.Input,`
`102`	`102`	`validator=FloatBoundedValidator(lower=0.0, upper=180.0),`
`103`		`- doc="omega rotation between component of goniometer axis in XY-plane from +ve Y-axis(perpendicular to ki)",`
	`103`	`+ doc="omega rotation between component of goniometer axis in XY-plane from +ve Y-axis (perpendicular to ki)",`
`104`	`104`	`)`
`105`	`105`	`self.declareProperty(`
`106`	`106`	`name="OmegaHand",`
Original file line number	Diff line number	Diff line change
`@@ -137,7 +137,7 @@ def PyInit(self):`
`137`	`137`	`self.declareProperty(`
`138`	`138`	`name="KeepIntermediateWorkspaces",`
`139`	`139`	`defaultValue=False,`
`140`		`- doc="Whether to keep the intermediate sample and calibration\nworkspaces for diagnostic checks.",`
	`140`	`+ doc="Whether to keep the intermediate sample and calibration workspaces for diagnostic checks.",`
`141`	`141`	`)`
`142`	`142`
`143`	`143`	`self.declareProperty(`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ def PyInit(self):`
`38`	`38`	`self.declareProperty(`
`39`	`39`	`"CheckInstruments",`
`40`	`40`	`True,`
`41`		`- "If checked, only workspaces with equal instrument parameters are merged.Do not disable without a very good reason.",`
	`41`	`+ "If checked, only workspaces with equal instrument parameters are merged. Do not disable without a very good reason.",`
`42`	`42`	`)`
`43`	`43`
`44`	`44`	`def PyExec(self):`