summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLee Jarvis <leejarvis@fastmail.com>2017-07-26 20:15:52 +0100
committerLee Jarvis <leejarvis@fastmail.com>2017-07-26 20:15:52 +0100
commitbdd21e885e577ed42459c9afe185ede8e9d25fde (patch)
treee8d414fdb4d25044045780385f5a2ffb3c3714e3
parent723cfdd1f2b993266df236eafd829fc199b8625d (diff)
downloadslop-bdd21e885e577ed42459c9afe185ede8e9d25fde.tar.gz
Add README note about NullOption callbacks
closes #213
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4cb690d..505d4c5 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,12 @@ opts.check_ssl_certificate? #=> true
opts.to_hash #=> { host: "192.168.0.1", port: 80, verbose: true, quiet: false, check_ssl_certificate: true }
```
+Note that the block we've added to the `--version` flag will be executed
+during parse time. Therefore these blocks should be reserved
+for immediately reacting to the presence of a flag. If you want to
+access other options or mutate values, check out the "Custom option types"
+section below and implement the `#finish` method.
+
Option types
------------