[latex3-commits] [latex3/latex3] main: Fix wrong index entries (b6fd5591b)

[github at latex-project.org]

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

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

commit b6fd5591b04dfff9e601825608a78322cbdccce9
Author: Yukai Chou <muzimuzhi at gmail.com>
Date:   Thu Oct 19 04:56:51 2023 +0800

    Fix wrong index entries
    
    - Complete arg-spec for functions
    - Add `no-index` option for partial or special csnames


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

b6fd5591b04dfff9e601825608a78322cbdccce9
 l3kernel/l3color.dtx | 4 ++--
 l3kernel/l3int.dtx   | 2 +-
 l3kernel/l3keys.dtx  | 2 +-
 l3kernel/l3prop.dtx  | 2 +-
 l3kernel/l3regex.dtx | 4 ++--
 l3kernel/l3sys.dtx   | 2 +-
 l3kernel/l3text.dtx  | 2 +-
 l3kernel/l3token.dtx | 2 +-
 8 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/l3kernel/l3color.dtx b/l3kernel/l3color.dtx
index 3d225b2d2..b72019292 100644
--- a/l3kernel/l3color.dtx
+++ b/l3kernel/l3color.dtx
@@ -330,7 +330,7 @@
 %
 % \subsection{Coloring math mode material}
 %
-% Coloring math mode material using \cs{color_select:nn(n)} has some restrictions
+% Coloring math mode material using \cs[no-index]{color_select:nn(n)} has some restrictions
 % and often leads to spacing issues and/or poor input syntax. Avoiding generating
 % \tn{mathord} atoms whilst coloring only those parts of the input which are
 % required needs careful handling. The functionality here covers this important
@@ -341,7 +341,7 @@
 %     \cs{color_math:nn} \Arg{color expression}\Arg{content}
 %     \cs{color_math:nnn} \Arg{model(s)} \Arg{value(s)} \Arg{content}
 %   \end{syntax}
-%   Works as for \cs{color_select:n(n)} but applies color only to the math mode
+%   Works as for \cs[no-index]{color_select:n(n)} but applies color only to the math mode
 %   \meta{content}. The function does not generate a group and the \meta{content}
 %   therefore retains its math atom states. Sub/superscripts are also properly
 %   handled.
diff --git a/l3kernel/l3int.dtx b/l3kernel/l3int.dtx
index e012e191d..c39ed7551 100644
--- a/l3kernel/l3int.dtx
+++ b/l3kernel/l3int.dtx
@@ -94,7 +94,7 @@
 % \int_show:n { \l_my_tl +  \l_my_int * 3 - ( 3 + 4 * 5 ) }
 % \end{verbatim}
 % show the same result $-6$ because \cs[no-index]{l_my_tl} expands to
-% the integer denotation~|5| while the integer variable \cs{l_my_int}
+% the integer denotation~|5| while the integer variable \cs[no-index]{l_my_int}
 % takes the value~$4$.  As the \meta{integer expression} is fully
 % expanded from left to right during evaluation, fully expandable and
 % restricted-expandable functions can both be used, and \cs{exp_not:n}
diff --git a/l3kernel/l3keys.dtx b/l3kernel/l3keys.dtx
index 3e77e89ce..b7bfac984 100644
--- a/l3kernel/l3keys.dtx
+++ b/l3kernel/l3keys.dtx
@@ -385,7 +385,7 @@
 %   \begin{syntax}
 %     \meta{key} .legacy_if_set:n = \meta{switch}
 %   \end{syntax}
-%   Defines \meta{key} to set legacy \cs{if} \meta{switch} to \meta{value}
+%   Defines \meta{key} to set legacy \cs[no-index]{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
 %   \texttt{if}}.
diff --git a/l3kernel/l3prop.dtx b/l3kernel/l3prop.dtx
index 69cafe1cf..4ad4ef5a5 100644
--- a/l3kernel/l3prop.dtx
+++ b/l3kernel/l3prop.dtx
@@ -60,7 +60,7 @@
 % Each entry in a property list must have a unique \meta{key}: if an entry is
 % added to a property list which already contains the \meta{key} then the new
 % entry overwrites the existing one. The \meta{keys} are compared on a
-% string basis, using the same method as \cs{str_if_eq:nn}.
+% string basis, using the same method as \cs{str_if_eq:nnTF}.
 %
 % Property lists are intended for storing key-based information for use within
 % code.  This is in contrast to key--value lists, which are a form of
diff --git a/l3kernel/l3regex.dtx b/l3kernel/l3regex.dtx
index 87dfcec47..cb9d0b3de 100644
--- a/l3kernel/l3regex.dtx
+++ b/l3kernel/l3regex.dtx
@@ -921,7 +921,7 @@
 %   \item Optimize states with a single \cs[no-index]{__regex_action_free:n}.
 %   \item Optimize the use of \cs[no-index]{__regex_action_success:} by inserting it
 %     in state $2$ directly instead of having an extra transition.
-%   \item Optimize the use of \cs{int_step_...} functions.
+%   \item Optimize the use of \cs[no-index]{int_step_...} functions.
 %   \item Groups don't capture within regexes for csnames; optimize and
 %     document.
 %   \item Better \enquote{show} for anchors, properties, and catcode tests.
@@ -930,7 +930,7 @@
 %     numbers.
 %   \item Instead of checking whether the character is special or
 %     alphanumeric using its character code, check if it is special in
-%     regexes with \cs{cs_if_exist} tests.
+%     regexes with \cs[no-index]{cs_if_exist} tests.
 % \end{itemize}
 %
 % The following features are likely to be implemented at some point
diff --git a/l3kernel/l3sys.dtx b/l3kernel/l3sys.dtx
index 5e5759076..d7d73f1a6 100644
--- a/l3kernel/l3sys.dtx
+++ b/l3kernel/l3sys.dtx
@@ -299,7 +299,7 @@
 %   enabled.  This returns false if unrestricted shell escape is
 %   enabled.  Unrestricted shell escape is not considered a superset
 %   of restricted shell escape in this case.  To find whether any
-%   shell escape is enabled use \cs{sys_if_shell:}.
+%   shell escape is enabled use \cs{sys_if_shell:TF}.
 % \end{function}
 %
 % \begin{function}[added = 2017-05-27]
diff --git a/l3kernel/l3text.dtx b/l3kernel/l3text.dtx
index 0fe4ed9ce..9bcd67620 100644
--- a/l3kernel/l3text.dtx
+++ b/l3kernel/l3text.dtx
@@ -105,7 +105,7 @@
 %     \cs{text_uppercase:n}  \Arg{tokens}
 %     \cs{text_uppercase:nn} \Arg{BCP-47} \Arg{tokens}
 %   \end{syntax}
-%   Takes user input \meta{text} first applies \cs{text_expand}, then
+%   Takes user input \meta{text} first applies \cs{text_expand:n}, then
 %   transforms the case of character tokens as specified by the
 %   function name. The category code of letters are not changed by this
 %   process when Unicode engines are used; in $8$-bit engines, case changed
diff --git a/l3kernel/l3token.dtx b/l3kernel/l3token.dtx
index 14c62875c..a5b16fbff 100644
--- a/l3kernel/l3token.dtx
+++ b/l3kernel/l3token.dtx
@@ -1034,7 +1034,7 @@
 %     For instance \cs{peek_regex:nTF} \verb"{ abc | [a-z] }" |{ } { }|
 %     |abc| will only inspect the first token~|a| even though the first
 %     branch |abc| of the alternative is preferred in functions such as
-%     \cs{peek_regex_remove_once:n}.  This may have an effect on
+%     \cs{peek_regex_remove_once:nTF}.  This may have an effect on
 %     tokenization if the input stream has not yet been tokenized and
 %     category codes are changed.
 %   \end{texnote}