Made user manual edits and docstring edits according to review.

idaholab · Jun 10, 2022 · 08e843a · 08e843a
1 parent d444b2f
commit 08e843a
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 9 deletions.
diff --git a/doc/user_manual/PostProcessors/Validation.tex b/doc/user_manual/PostProcessors/Validation.tex
@@ -94,7 +94,7 @@ \subsubsection{Validation PostProcessors}
     it will output an error.
   \item \xmlNode{Targets}, \xmlDesc{comma separated string, required field}, specifies the names of the targets. Make sure the feature data are normalized by a nominal value. \nb Each target is paired with a feature listed in xml node \xmlNode{Features}.
     To enable user defined time interval selection, this postprocessor will only consider the first feature name provided. If user provides more than one,
-    itt will output an error.
+    it will output an error.
   \item \xmlNode{pivotParameter}, \xmlDesc{string, required field if HistorySet is used}, specifies the pivotParameter for a <HistorySet>.
     The pivot parameter is the shared index of the output variables in the data object.
   \item \xmlNode{Metric}, \xmlDesc{string, required field}, specifies the \textbf{Metric} name that is defined via
@@ -147,10 +147,6 @@ \subsubsection{Validation PostProcessors}
       \item \textbf{process\_time\_targetName\_featureName}, provides the shared process time data.  `targetName' and `featureName' are the string names of the input target and feature.
       \item \textbf{standard\_error\_targetName\_featureName}, provides the standard error of the overall transient data.  `targetName' and `featureName' are the string names of the input target and feature.
     \end{itemize}
-  \item \xmlNode{Options}
-  \begin{itemize}
-    \item \xmlNode{pivotParameter}
-  \end{itemize}
 \end{itemize}
 pivot parameter must be named `pivot\_parameter' and this array is assigned within the post-processor algorithm.
 

diff --git a/ravenframework/Models/PostProcessors/Validations/PPDSS.py b/ravenframework/Models/PostProcessors/Validations/PPDSS.py
@@ -62,16 +62,16 @@ class cls.
                                                                 on selected time interval. Values must be fractions of the full time interval.
                                                                 To distinguish strart and end, '|' should be placed between both values. Example: 0.0|0.4
                                                                 If 'None' is provided, the DSS postprocessing will be applied to the full interval.""")
-    separateFeatureDataInput.addParam("type", InputTypes.StringType, descr="""Specifies what type of user defined time intervals have been selected from
-                                                                    the feature pivot parameter. Options are currently `ratio' or `raw_values'""")
+    separateFeatureDataInput.addParam("type", InputTypes.StringType, descr=r"""Specifies what type of user defined time intervals have been selected from
+                                                                    the feature pivot parameter. Options are currently `ratio' or `raw\_values'""")
     inputSpecification.addSub(separateFeatureDataInput)
     separateTargetDataInput = InputData.parameterInputFactory("separateTargetData", contentType=InputTypes.StringType,
                                                                 descr="""Time points to separate target data and conduct DSS postprocessing
                                                                 on selected time interval. Values must be fractions of the full time interval.
                                                                 To distinguish strart and end, '|' should be placed between both values. Example: 0.0|0.4
                                                                 If 'None' is provided, the DSS postprocessing will be applied to the full interval.""")
-    separateTargetDataInput.addParam("type", InputTypes.StringType, descr="""Specifies what type of user defined time intervals have been selected from
-                                                                    the target pivot parameter. Options are currently `ratio' or `raw_values'""")
+    separateTargetDataInput.addParam("type", InputTypes.StringType, descr=r"""Specifies what type of user defined time intervals have been selected from
+                                                                    the target pivot parameter. Options are currently `ratio' or `raw\_values'""")
     inputSpecification.addSub(separateTargetDataInput)
     scaleTypeInput = InputData.parameterInputFactory("scale", contentType=InputTypes.makeEnumType("scale","scaleType",['DataSynthesis','2_2_affine','dilation','beta_strain','omega_strain','identity']),
                                                       descr="""Scaling type for the time transformation. Available types are DataSynthesis,