[latex3-commits] [latex3/latex3] main: Document "no-user-doc" (see #1345) (8f18823fc)

[github at latex-project.org]

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

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

commit 8f18823fc0ad5bacc204856aabff194937f5e53a
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Thu Nov 30 08:27:22 2023 +0000

    Document "no-user-doc" (see #1345)


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

8f18823fc0ad5bacc204856aabff194937f5e53a
 l3kernel/l3doc.dtx | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/l3kernel/l3doc.dtx b/l3kernel/l3doc.dtx
index 09d0df486..33fac4692 100644
--- a/l3kernel/l3doc.dtx
+++ b/l3kernel/l3doc.dtx
@@ -469,6 +469,10 @@ and all files in that bundle must be distributed together.
 % |T| nor |F|, to document functions such as \cs[no-index]{prop_get:NN}
 % which also have conditional forms (\cs[no-index]{prop_get:NNTF}).
 %
+% In a very small number of cases, there is no user documentation for
+% a \enquote{public} function. In these rare cases, the option
+% |no-user-doc| may be added to suppress the undefined reference that
+% would otherwise then arises.
 %
 % \DescribeMacro{\TestFiles}
 % \cs{TestFiles}\marg{list of files} is used to indicate which test