status-im
/
nim-confutils
mirror of https://github.com/status-im/nim-confutils.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Clarify that all param types for cli/dispatch must be concrete

This commit is contained in:
Zahary Karadjov 2019-11-08 16:52:13 +00:00
parent 6f5f030539
commit 71643c9141
No known key found for this signature in database
GPG Key ID: C8936F8A3073D609
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -191,7 +191,8 @@ dispatch(main)
Under the hood, using these APIs will result in calling `load` on an anonymous
configuration type having the same fields as the supplied proc params.
Any additional arguments given as `cli(args) do ...` and `dispatch(fn, args)`
will be passed to `load` without modification.
will be passed to `load` without modification. Please note that this requires
all parameters types to be concrete (non-generic).
This covers the basic usage of the library and the rest of the documentation
will describe the various ways the default behavior can be tweaked or extended.