[latex3-commits] [git/LaTeX3-latex3-latex3] main: Document newly added silent benchmark functions (see #918) (eadf25bd4)

[Bruno Le Floch]

Repository : https://github.com/latex3/latex3
On branch  : main
Link       : https://github.com/latex3/latex3/commit/eadf25bd421e64140621245bad50890f5597a638

>---------------------------------------------------------------

commit eadf25bd421e64140621245bad50890f5597a638
Author: Bruno Le Floch <blflatex at gmail.com>
Date:   Sat May 15 23:12:35 2021 +0200

    Document newly added silent benchmark functions (see #918)


>---------------------------------------------------------------

eadf25bd421e64140621245bad50890f5597a638
 l3experimental/l3benchmark/l3benchmark.dtx | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/l3experimental/l3benchmark/l3benchmark.dtx b/l3experimental/l3benchmark/l3benchmark.dtx
index c4cccbe16..06871de27 100644
--- a/l3experimental/l3benchmark/l3benchmark.dtx
+++ b/l3experimental/l3benchmark/l3benchmark.dtx
@@ -65,28 +65,33 @@
 %
 % \begin{variable}{\g_benchmark_time_fp, \g_benchmark_ops_fp}
 %   These variables store the results of the most recently run benchmark.
-%   \cs{g_benchmark_time_fp} stores the time \TeX{} took, and
+%   \cs{g_benchmark_time_fp} stores the time \TeX{} took in seconds, and
 %   \cs{g_benchmark_ops_fp} stores the estimated number of elementary
 %   operations. The latter is not set by
 %   \cs{benchmark_tic:}/\cs{benchmark_toc:}.
 % \end{variable}
 %
-% \begin{function}{\benchmark_once:n}
+% \begin{function}{\benchmark_once:n, \benchmark_once_silent:n}
 %   \begin{syntax}
+%     \cs{benchmark_once_silent:n} \Arg{code}
 %     \cs{benchmark_once:n} \Arg{code}
 %   \end{syntax}
-%   Prints to the terminal the time taken by \TeX{} to run the
-%   \meta{code}, and an estimated number of elementary operations.  The
+%   Determines the time \cs{g_benchmark_time_fp} (in seconds) taken by
+%   \TeX{} to run the \meta{code}, and an estimated number
+%   \cs{g_benchmark_ops_fp} of elementary operations.  In addition,
+%   \cs{benchmark_once:n} prints these values to the terminal.  The
 %   \meta{code} is run only once so the time may be quite inaccurate for
 %   fast code.
 % \end{function}
 %
-% \begin{function}{\benchmark:n}
+% \begin{function}{\benchmark:n, \benchmark_silent:n}
 %   \begin{syntax}
 %     \cs{benchmark:n} \Arg{code}
 %   \end{syntax}
-%   Prints to the terminal the time taken by \TeX{} to run the
-%   \meta{code}, and an estimated number of elementary operations.  The
+%   Determines the time \cs{g_benchmark_time_fp} (in seconds) taken by
+%   \TeX{} to run the \meta{code}, and an estimated number
+%   \cs{g_benchmark_ops_fp} of elementary operations.  In addition,
+%   \cs{benchmark:n} prints these values to the terminal.  The
 %   \meta{code} may be run many times and not within a group, thus code
 %   with side-effects may cause problems.
 % \end{function}