[latex3-commits] [latex3/latex3] main: Re-write text on public/private interfaces (a7a5853e8)

[github at latex-project.org]

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

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

commit a7a5853e8d989025df224d68a8115aeed7897241
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Mon Oct 9 22:14:23 2023 +0100

    Re-write text on public/private interfaces
    
    See #1252.


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

a7a5853e8d989025df224d68a8115aeed7897241
 l3kernel/expl3.dtx | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/l3kernel/expl3.dtx b/l3kernel/expl3.dtx
index 3d1c3a6a8..372eb85a9 100644
--- a/l3kernel/expl3.dtx
+++ b/l3kernel/expl3.dtx
@@ -311,8 +311,9 @@
 % or private.
 %
 % To allow clear separation of these two cases, the following convention
-% is used. Private functions should be defined with |__| added to the beginning
-% of the module name. Thus
+% is used. In private functions and variables, two |_| characters are
+% added to the start of the module name. On the other hand, public
+% interfaces to not have these two |_| character. Thus
 % \begin{verbatim}
 %   \module_foo:nnn
 % \end{verbatim}
@@ -323,8 +324,9 @@
 % is private to the module, and should \emph{not} be used outside of that
 % module.
 %
-% Similarly, private variables should use |__| to separate scope and
-% module name, such that
+% For variables, to avoid three |_| in a row, the separator for the variable
+% scope and any leading |_| for a private interface in the module part are
+% combined. Thus
 % \begin{verbatim}
 %   \l_module_foo_tl
 % \end{verbatim}