[latex3-commits] [latex3/latex3] develop, main: Document that non-existent objects return 0 (c84b4dfaf)

[github at latex-project.org]

Repository : https://github.com/latex3/latex3
On branches: develop,main
Link       : https://github.com/latex3/latex3/commit/c84b4dfaf775372a1ed24ef63904d09c49646107

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

commit c84b4dfaf775372a1ed24ef63904d09c49646107
Author: Joseph Wright <joseph at texdev.net>
Date:   Fri Apr 5 16:24:42 2024 +0100

    Document that non-existent objects return 0


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

c84b4dfaf775372a1ed24ef63904d09c49646107
 l3kernel/l3pdf.dtx | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/l3kernel/l3pdf.dtx b/l3kernel/l3pdf.dtx
index 300d88dbb..da5281d04 100644
--- a/l3kernel/l3pdf.dtx
+++ b/l3kernel/l3pdf.dtx
@@ -88,7 +88,8 @@
 %     \cs{pdf_object_ref:n} \Arg{object}
 %   \end{syntax}
 %   Inserts the appropriate information to reference the \meta{object}
-%   in for example page resource allocation
+%   in for example page resource allocation. If the \meta{object} does
+%   not exist then the function expands to a reference to object zero.
 % \end{function}
 %
 % \begin{function}[EXP, pTF, added = 2020-05-15]{\pdf_object_if_exist:n}
@@ -141,7 +142,9 @@
 %     \cs{pdf_object_ref_indexed:nn} \Arg{class} \Arg{index}
 %   \end{syntax}
 %   Inserts the appropriate information to reference the object of \meta{class}
-%   and \meta{index} in for example page resource allocation.
+%   and \meta{index} in for example page resource allocation. If the
+%   \meta{class}/\meta{index} combination does
+%   not exist then the function expands to a reference to object zero.
 % \end{function}
 %
 % \subsection{General functions}