# HG changeset patch
# User Franz Glasner <fzglas.hg@dom66.de>
# Date 1728303943 -7200
# Node ID 4cd2fd7ccf760e5d08e71da3de4239fb7e835d96
# Parent  772e4999562b6a88c20358817833a6ff961f5a08
farray.sh: docs: add a general note about resource management

diff -r 772e4999562b -r 4cd2fd7ccf76 share/local-bsdtools/farray.sh
--- a/share/local-bsdtools/farray.sh	Mon Oct 07 14:08:29 2024 +0200
+++ b/share/local-bsdtools/farray.sh	Mon Oct 07 14:25:43 2024 +0200
@@ -83,6 +83,12 @@
 #:   `null` (aka empty) and/or missing indexes are handled differently in
 #:   the function context.
 #:
+#: Resource management:
+#:
+#:   Done by reference counting of arrays and alists. No borrowed references
+#:   are ever returned. Every array and alist must be released using
+#:   `farray_release` or `falist_release`.
+#:
 #: Important:
 #:   All names that start with ``_farr_`` or ``__farr_`` are reserved
 #:   for private use in this module.