[GitHub] [jmeter] FSchumacher commented on a change in pull request #672: timeShift function docs update.

[GitBox <gi...@apache.org>]

FSchumacher commented on a change in pull request #672:
URL: https://github.com/apache/jmeter/pull/672#discussion_r712243041



##########
File path: xdocs/usermanual/functions.xml
##########
@@ -1575,13 +1575,14 @@ returns:
     </description>
 <properties>
         <property name="Format" required="No">
-        The format to be passed to DateTimeFormatter.
+        The format to be passed to DateTimeFormatter (for input data parsing and output formating).
         See <a href="https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html">DateTimeFormatter</a>
-        If omitted, the function uses milliseconds since epoch format.
+        If omitted, the function returns milliseconds.

Review comment:
       While it returns milliseconds, those are anchored at start of the unix epoch. Hence I think that detail should not be dropped.

##########
File path: xdocs/usermanual/functions.xml
##########
@@ -1575,13 +1575,14 @@ returns:
     </description>
 <properties>
         <property name="Format" required="No">
-        The format to be passed to DateTimeFormatter.
+        The format to be passed to DateTimeFormatter (for input data parsing and output formating).
         See <a href="https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html">DateTimeFormatter</a>
-        If omitted, the function uses milliseconds since epoch format.
+        If omitted, the function returns milliseconds.
         </property>
         <property name="Date to shift" required="No">
         Indicate the date in the format set by the parameter <code>Format</code> to shift.
-        If omitted, the date is set to <em>now</em>.
+        If omitted, the date is set to <em>ZonedDateTime.now</em> with system zone <em>ZoneId.systemDefault()</em>.
+        If <code>Format</code> parameter is not set then this property (if required) must be set as number of milliseconds eg.: Format="" and "Date to shift"=10000 then if "value to shift"=PT10S then result=20000 (20sec)

Review comment:
       This last line feels like an example/explaining note to me. Should this be in an extra `note` paragraph?
   At other places in this documentation, we use the `code`-tag for the name of parameters, when mentioned in the docs, would not this be helpful here, too?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@jmeter.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org