[latex3-commits] [latex3/latex3] main: More work on docs (1f06b7656)

[github at latex-project.org]

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

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

commit 1f06b76562c2140cd24b220e85fe345f59f771d0
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Mon May 22 10:01:07 2023 +0100

    More work on docs


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

1f06b76562c2140cd24b220e85fe345f59f771d0
 l3kernel/l3skip.dtx | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

diff --git a/l3kernel/l3skip.dtx b/l3kernel/l3skip.dtx
index 451d93607..fc8a93494 100644
--- a/l3kernel/l3skip.dtx
+++ b/l3kernel/l3skip.dtx
@@ -592,23 +592,25 @@
 %   \end{syntax}
 %   Evaluates the \meta{dim exprs}, and leaves the value of
 %   \meta{dim expr_1}, expressed in a unit given by \meta{dim expr_2}, in
-%   the input stream.  The result is a decimal number, rounded by \TeX{}
-%   to four or five decimal places.  If the decimal part of the result
+%   the input stream. If the decimal part of the result
 %   is zero, it is omitted, together with the decimal marker.
+%   The precisions of the result is limited
+%   to a maximum of five decimal places with trailing zeros omitted.
 %
 %   For example
 %   \begin{verbatim}
 %     \dim_to_decimal_in_unit:nn { 1bp } { 1mm }
 %   \end{verbatim}
 %   leaves |0.35278| in the input stream, \emph{i.e.}~the magnitude of
-%   one big point when converted to millimetres.
-%
-%   Note that this function is not optimised for any particular output
-%   and as such may give different results to \cs{dim_to_decimal_in_bp:n}
-%   or \cs{dim_to_decimal_in_sp:n}. In particular, the latter is able to
-%   take a wider range of input values as it is not limited by the ability
-%   to calculate a ratio using \eTeX{} primitives, which is required
-%   internally by \cs{dim_to_decimal_in_unit:nn}.
+%   one big point when expressed in millimetres. The conversions do
+%   \emph{not} guarantee that \TeX{} would yield identical results
+%   for the direct input in an equality test, hence
+%   \begin{verbatim}
+%     \dim_compare:nNnTF
+%       { \dim_to_decimal_in_unit:nn { 1bp } { 1mm } mm }
+%       { 1bp }
+%   \end{verbatim}
+%   will take the \texttt{false} branch.
 % \end{function}
 %
 % \begin{function}[EXP, added = 2012-05-08, tested = m3fp-convert002]