summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authordefanor <defanor@uberspace.net>2017-12-04 06:57:25 +0300
committerdefanor <defanor@uberspace.net>2017-12-04 06:57:25 +0300
commit95c890dbcd07b7355399e122191a362714cd52b9 (patch)
tree26e8ccdb3f9f2537a76b82d80a945f4b5e8adc09 /README.md
parent8218779504205227f0ea70d0c91270ff504d67a6 (diff)
downloadcoalpit-95c890dbcd07b7355399e122191a362714cd52b9.zip
coalpit-95c890dbcd07b7355399e122191a362714cd52b9.tar.gz
coalpit-95c890dbcd07b7355399e122191a362714cd52b9.tar.bz2
Make record selectors for mandatory arguments optional
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/README.md b/README.md
index 6992749..27c0bd1 100644
--- a/README.md
+++ b/README.md
@@ -32,14 +32,22 @@ Input { something = Nothing
, fooBar2 = Bar}
```
-Its serialized version should look like this:
+With the default modifiers, its serialized version should look like
+this:
```haskell
-["--foobar","foo","--arg1","1","--arg2","a string","--foobar2","bar"]
+["--foobar","foo","1","a string","bar"]
```
What would look like this in a shell:
```sh
+--foobar foo 1 'a string' bar
+```
+
+A more verbose version can be produced with `alwaysAddSelName = True`,
+while parsing would accept either version:
+
+```sh
--foobar foo --arg1 1 --arg2 'a string' --foobar2 bar
```