[latex3-commits] [git/LaTeX3-latex3-latex3] master: Document \CurrentOption in l3keys2e (see #668) (a2fc9f0fd)

[Joseph Wright]

Repository : https://github.com/latex3/latex3
On branch  : master
Link       : https://github.com/latex3/latex3/commit/a2fc9f0fd237272aface0e4968adbdb5ded836f5

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

commit a2fc9f0fd237272aface0e4968adbdb5ded836f5
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Sat Feb 8 07:32:07 2020 +0000

    Document \CurrentOption in l3keys2e (see #668)


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

a2fc9f0fd237272aface0e4968adbdb5ded836f5
 l3packages/CHANGELOG.md          | 4 ++++
 l3packages/l3keys2e/l3keys2e.dtx | 6 ++++++
 2 files changed, 10 insertions(+)

diff --git a/l3packages/CHANGELOG.md b/l3packages/CHANGELOG.md
index b889b474e..e4f0f6e24 100644
--- a/l3packages/CHANGELOG.md
+++ b/l3packages/CHANGELOG.md
@@ -7,6 +7,10 @@ this project uses date-based 'snapshot' version identifiers.
 
 ## [Unreleased]
 
+### Changed
+- Document that `\CurrentOption` is available and should be used in
+  `l3keys2e`
+
 ## [2020-02-03]
 
 ### Fixed
diff --git a/l3packages/l3keys2e/l3keys2e.dtx b/l3packages/l3keys2e/l3keys2e.dtx
index 08fa50ba8..e24876007 100644
--- a/l3packages/l3keys2e/l3keys2e.dtx
+++ b/l3packages/l3keys2e/l3keys2e.dtx
@@ -118,6 +118,12 @@
 %   \LaTeXe{} kernel function \cs{ProcessOptions}).
 % \end{function}
 %
+% When passing unknown keys to other packages, the standard \LaTeX{}
+% \tn{CurrentOption} command is available and should be used. In contrast
+% to \cs{l_keys_key_str}, \cs{CurrentOption} is a token list and thus retains
+% category code information. Depending on how options are used by third-party
+% packages, this may be essential for the option to be recognised.
+%
 %\end{documentation}
 %
 %\begin{implementation}