[latex3-commits] [latex3/latex3] main: Add a note on ~/space chars in msg text (fixes #942) (8560fc039)

[github at latex-project.org]

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

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

commit 8560fc039e1f1dae0e983ed4b5284c2187f065c6
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Fri May 19 08:04:23 2023 +0100

    Add a note on ~/space chars in msg text (fixes #942)


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

8560fc039e1f1dae0e983ed4b5284c2187f065c6
 l3kernel/l3msg.dtx | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/l3kernel/l3msg.dtx b/l3kernel/l3msg.dtx
index c256def11..16ca34d31 100644
--- a/l3kernel/l3msg.dtx
+++ b/l3kernel/l3msg.dtx
@@ -91,6 +91,18 @@
 % \end{verbatim}
 % will allow to filter out specifically messages from the \texttt{submodule}.
 %
+% Some authors may find the need to include spaces as |~| characters
+% tedious. This can be avoided by locally reseting the cateogry code
+% of \verb*| |.
+% \begin{verbatim}
+%   \char_set_catcode_space:n { `\ }
+%   \msg_new:nnn { foo } { bar }
+%      {Some message text using '#1' and usual message shorthands \{ \ \ \}.}
+%   \char_set_catcode_ignore:n { `\ }
+% \end{verbatim}
+% although in general this may be confusing; simply writing the messages
+% using |~| characters is the method favored by the team.
+%
 % \begin{function}[updated = 2011-08-16]{\msg_new:nnnn, \msg_new:nnn}
 %   \begin{syntax}
 %     \cs{msg_new:nnnn} \Arg{module} \Arg{message} \Arg{text} \Arg{more text}