[latex3-commits] [latex3/latex3] main: Document l3doc class options (See #1369) (b0e717494)

[github at latex-project.org]

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

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

commit b0e717494fb216aea8d8be6d20ecd826f7063d68
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Sun Dec 10 20:13:24 2023 +0000

    Document l3doc class options (See #1369)
    
    I think several options should be bool-based
    and we should use l3keys: docs written assuming
    a change here.


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

b0e717494fb216aea8d8be6d20ecd826f7063d68
 l3kernel/l3doc.dtx | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/l3kernel/l3doc.dtx b/l3kernel/l3doc.dtx
index b6f98aa36..2db86afbc 100644
--- a/l3kernel/l3doc.dtx
+++ b/l3kernel/l3doc.dtx
@@ -221,6 +221,56 @@ and all files in that bundle must be distributed together.
 % Latin Modern fonts.  To prevent this, use the class option
 % |cm-default|.
 %
+% \subsection{Class options}
+%
+% The class recognises a number of options, some of which are generally
+% useful and some of which are aimed squarely at use by the kernel team only.
+%
+% \DescribeOption{full}
+% \DescribeOption{onlydoc}
+% When the \texttt{full} option is set (the standard setting), both the
+% documentation and implementation parts of the source are typeset. If on the
+% other hand the \texttt{onlydoc} option is set, only the documentation part
+% is typeset.
+%
+% \DescribeOption{lm-default}
+% Selects whether the standard font set up is Latin Modern in the \texttt{T1}
+% encoding (the standard setting) or leaves the font setup unchanged.
+%
+% \DescribeOption{kernel}
+% Determines whether \pkg{l3doc} treats |\__kernel_| commands and
+% |\(c|g|l)__kernel_| variables as allowable in code. In general,
+% \emph{no} internal material from outside the current module is allowed.
+% However, for bootstrapping the \pkg{expl3} kernel, a small number of
+% cross-module functions are needed. To suppress the error message that
+% would otherwise arise, the class option \texttt{kernel} may be given.
+%
+% \DescribeOption{check}
+% When the \texttt{check} option is given, the class will record all commands
+% defined and documented in a \texttt{\meta{name}.cmds} file. This will show
+% which are both documented and defined, which are only documented and which
+% are only defined. (Here, \enquote{defined} means listed using a
+% \texttt{macro} or \texttt{variable} environment in the implementation part of
+% the source file).
+%
+% \DescribeOption{checktest}
+% When \texttt{checktest} is given as an option, the class will check that each
+% function entry in the implementation part of the source is marked using
+% \cs{UnitTest}.
+%
+% \DescribeOption{show-notes}
+% \DescribeOption{hide-notes}
+% These complementary options determine if the information given using the
+% \cs{NB} and \cs{NOTE} commands is printed.
+%
+% \DescribeOption{cs-break-off}
+% \DescribeOption{cs-break-nohyphen}
+% The commands \cs{cmd} and \cs{cs} allow hyphenation of control sequences
+% after (most) underscores. By default, a hyphen is used to mark the
+% hyphenation, but this can be changed with the \texttt{cs-break-nohyphen}
+% class option. To disable hyphenation of control sequencies entirely, use
+% \texttt{cs-break-off}.
+%
 % \subsection{Partitioning documentation and implementation}
 %
 % \pkg{doc} uses the \cs{OnlyDocumentation}/\cs{AlsoImplementation}