address review

- updated wording - added docstrings
idaholab · Nov 24, 2024 · 6066950 · 6066950
1 parent c915948
commit 6066950
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 7 deletions.
diff --git a/framework/doc/content/source/postprocessors/NumTimeSteps.md b/framework/doc/content/source/postprocessors/NumTimeSteps.md
@@ -1,11 +1,7 @@
-# TimestepSize
+# NumTimeSteps
 
 !syntax description /Postprocessors/NumTimeSteps
 
-## Description
-
-`NumTimeSteps` reports the timestep size.
-
 ## Example Input Syntax
 
 !listing /Users/achaube/tools/moose/test/tests/postprocessors/num_time_steps/moose.i block=Postprocessors

diff --git a/framework/include/postprocessors/NumTimeSteps.h b/framework/include/postprocessors/NumTimeSteps.h
@@ -11,6 +11,9 @@
 
 #include "GeneralPostprocessor.h"
 
+/**
+ * Reports on the number of time steps already taken in the transient
+ */
 class NumTimeSteps : public GeneralPostprocessor
 {
 public:

diff --git a/test/tests/postprocessors/num_time_steps/tests b/test/tests/postprocessors/num_time_steps/tests
@@ -3,7 +3,7 @@
     type = 'CSVDiff'
     input = 'numtimesteps.i'
     csvdiff = 'numtimesteps_out.csv'
-    requirement = 'The postprocessor `NumTimeSteps` shall count the number of time-steps accurately'
-                   'over the course of a transient solve'
+    requirement = 'The shall be able to count the number of time-steps that have been taken '
+                   'over the course of the simulation of a transient.'
   []
 []