[latex3-commits] [latex3/latex3] main: l3prop documentation changes suggested by Ulrike and Chris (627d4e65e)

[github at latex-project.org]

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

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

commit 627d4e65e96139fe4732804ad95905e32e6a041b
Author: Bruno Le Floch <blflatex at gmail.com>
Date:   Sun Feb 11 17:26:21 2024 +0100

    l3prop documentation changes suggested by Ulrike and Chris


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

627d4e65e96139fe4732804ad95905e32e6a041b
 l3kernel/l3prop.dtx | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/l3kernel/l3prop.dtx b/l3kernel/l3prop.dtx
index 4d5826173..73d7dd664 100644
--- a/l3kernel/l3prop.dtx
+++ b/l3kernel/l3prop.dtx
@@ -84,7 +84,7 @@
 %
 %   \item
 %     The \enquote{linked} storage method is meant for property lists with a
-%     large numbers of entries.  It has more memory overhead, but is
+%     large numbers of entries.  It takes up more of \TeX{}'s memory during a run, but is
 %     significantly faster (for long lists) when accessing or modifying
 %     individual entries using functions such as \cs{prop_if_in:Nn},
 %     \cs{prop_item:Nn}, \cs{prop_put:Nnn}, \cs{prop_get:NnN},
@@ -691,6 +691,9 @@
 %
 % \section{Scratch property lists}
 %
+% There is no need to include both flat and linked property lists as
+% scratch variables.  We arbitrarily pick the older implementation.
+%
 % \begin{variable}[added = 2012-06-23]{\l_tmpa_prop, \l_tmpb_prop}
 %   Scratch \enquote{flat} property lists for local assignment.
 %   These are never used by
@@ -948,6 +951,9 @@
 %   characters, and increment this integer for use in the next linked property
 %   list.  No need to optimize since this is only used when declaring the
 %   property list the first time.
+%   The aim here is to make this string as short as we can, given the
+%   range of distinct characters available.  This speeds up the work of
+%   \cs{cs:w} \ldots{} \cs{cs_end:} that looks up keys in the hash table.
 %    \begin{macrocode}
 \cs_new_protected:Npn \@@_next_prefix:
   {