docs: Add examples to documentation

2023-02-15 18:12:31 +01:00
parent 9de87a6acd
commit 294cfb1b58
6 changed files with 176 additions and 11 deletions
@@ -15,6 +15,12 @@ Display error message in stderr, prefixed by check emoji

 Display error message in stderr, prefixed by check emoji

+#### Example
+
+```bash
+show_error "Oh snap, that went horribly wrong"
+```
+
 #### Arguments

 * **$1** (string): Error message to display
@@ -23,6 +29,12 @@ Display error message in stderr, prefixed by check emoji

 Display success message in stderr, prefixed by cross emoji

+#### Example
+
+```bash
+show_success "There it is! World peace."
+```
+
 #### Arguments

 * **$1** (string): Success message to display