Skip to content
This repository was archived by the owner on May 20, 2024. It is now read-only.

Commit 92a70dc

Browse files
CodingMarkusCodingMarkus
authored andcommitted
Improve documentation of lists
1 parent 3912c91 commit 92a70dc

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

lib/psst/basic/list.inc.sh

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,22 @@ INCLUDE_SEEN_PSST="${INCLUDE_SEEN_PSST-}:list:"
4949
# There are no functions to append or prepend values to lists, as that can
5050
# easily be done as follows:
5151
#
52-
# newList1="$newValue$sep$oldList"
53-
# newList2="$oldList$newValue$sep"
52+
# newList1="$newValue$del$oldList"
53+
# newList2="$oldList$newValue$del"
5454
#
55-
# With $sep representing the separator character.
55+
# With `$del` representing the delimiter character. Of course, this only
56+
# works correctly if the new value does not contain `$del`, otherwise it
57+
# would be interpreted as multiple values being added to the list at once,
58+
# which sometimes may even be desirable. It is even possible to concatenate
59+
# two lists to each other as long as they both use the same delimiter:
5660
#
57-
# These is also no function to iterate over a list as this can simply be done
61+
# newList1="$list1$list2"
62+
# newList2="$list2$list1"
63+
#
64+
# There is also no function to iterate over a list as this can simply be done
5865
# using the following piece of code:
5966
#
60-
# ifs_set_psst "$sep"
67+
# ifs_set_psst "$del"
6168
# for listValue in $list
6269
# do
6370
# # Do something with $listValue

0 commit comments

Comments
 (0)