[latex3-commits] [latex3/latex3] main: Add a note about catcode for file ops (583c2a9c0)

[github at latex-project.org]

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

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

commit 583c2a9c01a500ebb8b48aee18c1d3714197fdc0
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Sun Dec 10 20:30:12 2023 +0000

    Add a note about catcode for file ops
    
    Fixes #1358.


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

583c2a9c01a500ebb8b48aee18c1d3714197fdc0
 l3kernel/l3file.dtx | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/l3kernel/l3file.dtx b/l3kernel/l3file.dtx
index 9578156eb..b04cdd57f 100644
--- a/l3kernel/l3file.dtx
+++ b/l3kernel/l3file.dtx
@@ -726,6 +726,12 @@
 %
 % \subsection{Information about files and file contents}
 %
+% Functions in this section return information about files as \pkg{expl3}
+% \texttt{str} data, \emph{except} that the non-expandable functions set their
+% return \emph{token list} to \cs{q_no_value} if the file requested is not
+% found. As such, comparison of file names, hashes, sizes, etc., should use
+% \cs{str_if_eq:nnTF} rather than \cs{tl_if_eq:nnTF} and so on.
+%
 % \begin{function}[rEXP, added = 2019-11-19]
 %   {
 %     \file_hex_dump:n,   \file_hex_dump:V,