changeset 504:277c58d6ffba

array.sh: improve docs
author Franz Glasner <fzglas.hg@dom66.de>
date Sat, 31 Aug 2024 14:04:54 +0200
parents 49d506213239
children ace88a4831f7
files share/local-bsdtools/array.sh
diffstat 1 files changed, 4 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/share/local-bsdtools/array.sh	Fri Aug 30 21:31:38 2024 +0200
+++ b/share/local-bsdtools/array.sh	Sat Aug 31 14:04:54 2024 +0200
@@ -51,12 +51,15 @@
 #:
 #: Create a new array
 #:
+#: It is assumed that the array does not exist already.
+#:
 #: Args:
 #:   $1 (str): The name of the array.
 #:             Must conform to shell variable naming conventions
 #:   $2... (optional): Optional initialization values
 #:
-#: It is assumed that the array does not exist already.
+#: Exit:
+#:   Iff the array already exists.
 #:
 array_create() {
     local _name