From a8a16ca4738aa14308454bffdb9186ff4ecfb25e Mon Sep 17 00:00:00 2001 From: Jan Lehnardt Date: Sun, 18 Dec 2022 12:42:58 +0100 Subject: [PATCH] doc: add default values in signature --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fb62d3f..c1630f1 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Requires `bash`. Signature: ```shell -wait_for_url url [iterations duration] +wait_for_url url [iterations=1 duration=1] ``` Usage: @@ -46,7 +46,7 @@ Requires `bash`. Signature: ```shell -wait_for_pid_exit pid [iterations duration] +wait_for_pid_exit pid [iterations=3 duration=1] ``` Usage: @@ -66,12 +66,12 @@ wait_for_pid_exit 3618 5 3 ## `error_and_exit $message` -Prints an error message and then exits with exit code `1`. +Prints an error message and then exits with exit code `1`. The message defaults to `error` Signature: ```shell -error_and_exit [message] +error_and_exit [message=error] ``` Usage: