[latex3-commits] [git/LaTeX3-latex3-latex3] filename-sanitize: Update documentation (5b96e011a)

[PhelypeOleinik]

Repository : https://github.com/latex3/latex3
On branch  : filename-sanitize
Link       : https://github.com/latex3/latex3/commit/5b96e011a409f4f3f2cca9c8077f7a884f25db8d

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

commit 5b96e011a409f4f3f2cca9c8077f7a884f25db8d
Author: PhelypeOleinik <phelype.oleinik at latex-project.org>
Date:   Sat Apr 17 16:38:58 2021 -0300

    Update documentation


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

5b96e011a409f4f3f2cca9c8077f7a884f25db8d
 l3kernel/l3kernel-functions.dtx | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/l3kernel/l3kernel-functions.dtx b/l3kernel/l3kernel-functions.dtx
index f785b26b2..3fadc117b 100644
--- a/l3kernel/l3kernel-functions.dtx
+++ b/l3kernel/l3kernel-functions.dtx
@@ -147,16 +147,19 @@
 %   \begin{syntax}
 %     \cs{__kernel_file_missing:n} \Arg{name}
 %   \end{syntax}
-%   Expands the \meta{name} as per \cs{__kernel_file_name_sanitize:nN} then
+%   Expands the \meta{name} as per \cs{__kernel_file_name_sanitize:n} then
 %   produces an error message indicating that this file was not found.
 % \end{function}
 %
-% \begin{function}{\__kernel_file_name_sanitize:nN}
+% \begin{function}[EXP,updated = 2021-04-17]{\__kernel_file_name_sanitize:n}
 %   \begin{syntax}
-%     \cs{__kernel_file_name_sanitize:nN} \Arg{name} \meta{str var}
+%     \cs{__kernel_file_name_sanitize:n} \Arg{name}
 %   \end{syntax}
-%   For converting a \meta{name} to a string where active characters are treated
-%   as strings.
+%   Expands the file name using a \tn{csname}-based approach, and
+%   relies on active characters (for example from UTF-8 characters)
+%   being properly set up to expand to a expansion-safe version using
+%   \cs{ifcsname}.  This is less conservative than the token-by-token
+%   approach used before, but it is much faster.
 % \end{function}
 %
 % \begin{function}{\__kernel_file_input_push:n, \__kernel_file_input_pop:}