[latex3-commits] [latex3/latex3] main: Docu \__kernel_iow_open:Nn in l3kernel-functions.dtx (a7cf30f02)

[github at latex-project.org]

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

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

commit a7cf30f0244bc60c1954b4305921fc32ca8815e7
Author: Yukai Chou <muzimuzhi at gmail.com>
Date:   Mon Mar 25 20:19:22 2024 +0800

    Docu \__kernel_iow_open:Nn in l3kernel-functions.dtx
    
    Also update example function which uses \__kernel_ior_open:Nn.
    See #1516.


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

a7cf30f0244bc60c1954b4305921fc32ca8815e7
 l3kernel/l3kernel-functions.dtx | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/l3kernel/l3kernel-functions.dtx b/l3kernel/l3kernel-functions.dtx
index 480425d73..f7b629eca 100644
--- a/l3kernel/l3kernel-functions.dtx
+++ b/l3kernel/l3kernel-functions.dtx
@@ -333,7 +333,21 @@
 %   higher-level
 %   functions which have already fully expanded the \meta{file name} and which
 %   need to perform multiple open or close operations. See for example the
-%   implementation of \cs{file_get_full_name:nN},
+%   implementation of \cs{ior_shell_open:Nn}.
+% \end{function}
+%
+% \begin{function}{\__kernel_iow_open:Nn, \__kernel_iow_open:No}
+%   \begin{syntax}
+%     \cs{__kernel_iow_open:Nn} \meta{stream} \Arg{file name}
+%   \end{syntax}
+%   This function has identical syntax to the public version. However,
+%   is does not take precautions against active characters in the
+%   \meta{file name}, and it does not attempt to add a \meta{path} to
+%   the \meta{file name}: it is therefore intended to be used by
+%   higher-level
+%   functions which have already fully expanded the \meta{file name} and which
+%   need to perform multiple open or close operations. See for example the
+%   implementation of \cs{iow_shell_open:Nn}.
 % \end{function}
 %
 % \begin{function}{\__kernel_iow_with:Nnn}