Skip to content

Commit d016ac3

Browse files
committed
Add information on var options
1 parent 8e8edb2 commit d016ac3

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

index.adoc

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,8 @@ to the logger. We use `:duct/logger` instead of `:duct.logger/simple`,
296296
as keys have a logical hierarchy, and `:duct/logger` fulfils a role
297297
similar to that of an interface or superclass.
298298

299-
NOTE: The '`ig`' in `#ig/var` stands for _Integrant_. This is the
299+
NOTE: The '`ig`' in `#ig/var` stands for
300+
https://github.com/weavejester/integrant[Integrant]. This is the
300301
library that Duct relies on to turn configurations into running
301302
applications.
302303

@@ -394,3 +395,14 @@ $ NAME=Clojurist duct --main
394395
✓ Initiating system...
395396
2024-11-24T04:45:54.211Z :report :tutorial.print/hello {:name "Clojurist"}
396397
----
398+
399+
Vars are defined as a map of symbols to maps of options. The following
400+
option keys are supported:
401+
402+
[horizontal]
403+
`:arg` :: a command-line argument to take the var's value from
404+
`:default` :: the default value if the var is not set
405+
`:doc` :: a description of what the var is for
406+
`:env` :: an environment variable to take the var's value from
407+
`:type` :: a data type to coerce the var into (one of: `:str`, `:int`
408+
or `float`)

0 commit comments

Comments
 (0)