doc: small fixes

This commit is contained in:
Kay Marquardt (Gnadelwartz) 2021-02-21 07:51:56 +01:00
parent 1a0642bcce
commit ac71000519
1 changed files with 6 additions and 7 deletions

View File

@ -1042,12 +1042,11 @@ ARRAY["key"]="value"
ARRAY["key,subkey"]="value2" ARRAY["key,subkey"]="value2"
``` ```
Only the following characters are allowed: `a-z A-Z 0-9 _ .` for keys, multiple keys must be separated by `,`. Only the following characters are allowed for keys: `a-z A-Z 0-9 _ .`, multiple keys must be separated by `,`.
Keys contaiing other characters will be discarded when written to a file. Keys contaiing other characters will be discarded when written to a file.
To delete (unset) a key/value pair in memory you can `unset ARRAY["abc"]` but this will not delete key/value To delete (unset) a key/value pair in memory you can `unset ARRAY["abc"]` but this will not delete the key/value
piars when using `jssh_updateDB`. Therefore the special value `${JSSHDB_UNSET}` exists to delete a key/value pair pair when using `jssh_updateDB` to update a file. Therefore the special value `${JSSHDB_UNSET}` exists, see `jssh_updateDB`
when updateting a file, see `jssh_updateDB`
```bash ```bash
@ -1205,8 +1204,8 @@ Note: Existing content not in ARRAY is kept in file.
*usage:* jssh_updateDB_async "ARRAY" "filename" *usage:* jssh_updateDB_async "ARRAY" "filename"
*Note:* `jssh_updateDB` updates new or changed keys/value pairs only, it will not delete an existing key/value pair. `jssh_updateDB` update new or changed keys/value pairs only, it will not delete an existing key/value pair.
If you want to delete a existing key/value pair assign the unset value `${JSSJDB__UNSET}`. To delete an existing key/value pair you must assign the "unset value" `${JSSJDB_UNSET}` to it instead.
*example:* *example:*
```bash ```bash
@ -1676,5 +1675,5 @@ The name of your bot is available as bash variable "$ME", there is no need to ca
#### [Prev Best Practice](5_practice.md) #### [Prev Best Practice](5_practice.md)
#### [Next Notes for Developers](7_develop.md) #### [Next Notes for Developers](7_develop.md)
#### $$VERSION$$ v1.45-dev-41-g192fae8 #### $$VERSION$$ v1.45-dev-42-g1a0642b