Skip to content

Commit 2417444

Browse files
committed
Added a note about the ARG_MUST_BE_DEFINED variable to the README
1 parent 4a90793 commit 2417444

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ argExpected['d|deamon|D']="argumentName - Argument description"
4343

4444
The `argumentName` part of the definition is the name given to the argument and what should be passed to the `argValue` and `argExists` functions, see below.
4545

46+
By default if an argument is passed that hasn't been defined an error will be thrown and the script will exit.
47+
This feature can be turned off by setting `ARG_MUST_BE_DEFINED` to `false`, note that the argument names will default to the argument its self, without the preceding hyphen(s).
48+
4649
### Get An Arguments Value
4750

4851
There is a helper function named `argValue()` which takes the name of

0 commit comments

Comments
 (0)