[latex3-commits] [git/LaTeX3-latex3-latex3] main: Document legacy switch support in l3keys (266e7591d)

[Joseph Wright]

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

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

commit 266e7591d25e34b79e98644456a5bfe70d3fc339
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Thu Nov 25 13:22:39 2021 +0000

    Document legacy switch support in l3keys


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

266e7591d25e34b79e98644456a5bfe70d3fc339
 l3kernel/l3keys.dtx | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/l3kernel/l3keys.dtx b/l3kernel/l3keys.dtx
index 51bfbec71..bc6828f06 100644
--- a/l3kernel/l3keys.dtx
+++ b/l3kernel/l3keys.dtx
@@ -358,6 +358,24 @@
 %   require a value at point-of-use unless a default is set.
 % \end{function}
 %
+% \begin{function}[updated = 2021-11-22]
+%   {
+%     .legacy_set:n, .legacy_gset:n,
+%     .legacy_set_inverse:n, .legacy_gset_inverse:n
+%   }
+%   \begin{syntax}
+%     \meta{key} .legacy_set:n = \meta{switch}
+%   \end{syntax}
+%   Defines \meta{key} to set legacy \cs{if} \meta{switch} to \meta{value}
+%   (which must be either \enquote{\texttt{true}} or \enquote{\texttt{false}}).
+%   The \meta{switch} is the name of the switch \emph{without the leading
+%   \cs{if}}. Note that in contrast to \pkg{expl3} variables, the \meta{switch}
+%   will \emph{not} be created if it does not exist.
+%
+%   The \texttt{inverse} versions will set the \meta{switch} to the logical
+%   opposite of the \meta{value}.
+% \end{function}
+%
 % \begin{function}[updated = 2013-07-10]{.meta:n}
 %   \begin{syntax}
 %     \meta{key} .meta:n = \Arg{keyval list}