unposted: comments explaining how hashtable must be created

See zsh-workers 46277, 46278, 46279.

1 files changed, 4 insertions, 1 deletions

diff --git a/Src/zsh.h b/Src/zsh.h
index 6101cf242..a97e83192 100644
--- a/Src/zsh.h
+++ b/Src/zsh.h
@@ -1180,7 +1180,10 @@ typedef void     (*ScanTabFunc)    _((HashTable, ScanFunc, int));
 
 typedef void (*PrintTableStats) _((HashTable));
 
-/* hash table for standard open hashing */
+/* Hash table for standard open hashing. Instances of struct hashtable can be *
+ * created only by newhashtable(). In fact, this function creates an instance *
+ * of struct hashtableimpl, which is made of struct hashtable (public part)   *
+ * and additional data members that are only accessible from hashtable.c.     */
 
 struct hashtable {
     /* HASHTABLE DATA */