Improvements to doc strings

aurora-multiphysics · Jan 10, 2025 · 43435c5 · 43435c5
1 parent 6a57aa1
commit 43435c5
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/src/auxkernels/TimeAverageAux.C b/src/auxkernels/TimeAverageAux.C
@@ -7,10 +7,10 @@ TimeAverageAux::validParams()
 {
   InputParameters params = AuxKernel::validParams();
 
-  params.addClassDescription("AuxKernel that performs time averaging of variables."
-                             "");
+  params.addClassDescription("AuxKernel that performs time averaging of variables.");
   params.addRequiredCoupledVar("scalars",
-                       "Scalar variables to be averaged");
+                       "Scalar variables to be averaged. If multiple scalars are "
+                       "given the average of their product is given");
   return params;
 }
 TimeAverageAux::TimeAverageAux(const InputParameters & parameters)

diff --git a/src/auxkernels/VectorTimeAverageAux.C b/src/auxkernels/VectorTimeAverageAux.C
@@ -13,10 +13,12 @@ VectorTimeAverageAux::validParams()
   params.addRequiredCoupledVar("vectors",
                        "Vector variables to be time averaged."
                        "If multiple vectors are provided the average of their "
-                       "scalar multiplication is given. ");
+                       "component-wise multiplication is given. ");
 
   params.addCoupledVar("scalars",
-                       "Scalar variables to be included in the time average.");
+                       "Scalar variables to be included in the time average. "
+                       "If scalars are are given the average of their product with the vector "
+                       "averages is given");
   return params;
 }
 VectorTimeAverageAux::VectorTimeAverageAux(const InputParameters & parameters)