aboutsummaryrefslogtreecommitdiff
path: root/core/flags
diff options
context:
space:
mode:
authorFeoramund <161657516+Feoramund@users.noreply.github.com>2025-06-09 10:58:54 -0400
committerFeoramund <161657516+Feoramund@users.noreply.github.com>2025-06-09 11:39:10 -0400
commit7c5700996f7b8bc569e8b505b916f5fa05042635 (patch)
tree7168aa9438ed938846d6325d8b3365ef50e1d807 /core/flags
parente20db8df890366f874bf4a956311b92be2d1ac51 (diff)
flags: Mention `varg` in the documentation
Diffstat (limited to 'core/flags')
-rw-r--r--core/flags/doc.odin7
1 files changed, 7 insertions, 0 deletions
diff --git a/core/flags/doc.odin b/core/flags/doc.odin
index b5c535d53..0763c01a7 100644
--- a/core/flags/doc.odin
+++ b/core/flags/doc.odin
@@ -20,6 +20,13 @@ The format is similar to the Odin binary's way of handling compiler flags.
-<map>:<key>=<value> set map[key] to value
+Unhandled Arguments:
+
+All unhandled positional arguments are placed into the `varg` field on a
+struct, if it exists. In UNIX-style parsing, the existence of a `--` on the
+command line will also pass all arguments afterwards into this field.
+
+
Struct Tags:
Users of the `core:encoding/json` package may be familiar with using tags to