diff options
| author | Bruce Hill <bruce@bruce-hill.com> | 2024-10-09 13:48:45 -0400 |
|---|---|---|
| committer | Bruce Hill <bruce@bruce-hill.com> | 2024-10-09 13:48:45 -0400 |
| commit | 5a80ff0db3690943a522e38152c86393ab0eb594 (patch) | |
| tree | e9acbe040b9216dc456b8d7f99852a42800ff998 /docs/command-line-parsing.md | |
| parent | 63d48e9febf2aa65de4cfd40489b05cbcdfd463a (diff) | |
Update docs to standardize function signature formatting
Diffstat (limited to 'docs/command-line-parsing.md')
| -rw-r--r-- | docs/command-line-parsing.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/command-line-parsing.md b/docs/command-line-parsing.md index 5d8af9d5..127cf232 100644 --- a/docs/command-line-parsing.md +++ b/docs/command-line-parsing.md @@ -18,10 +18,10 @@ for the arguments to `main()`: ```bash $ tomo greet.tm greet: Required argument 'name' was not provided! -Usage: greet [--help] <name> [--be-excited] +Signature: greet [--help] <name> [--be-excited] $ tomo greet.tm --help -Usage: greet [--help] <name> [--be-excited] +Signature: greet [--help] <name> [--be-excited] $ tomo greet.tm "Zaphod" Hi Zaphod. @@ -34,7 +34,7 @@ Hi Zaphod. $ tomo greet.tm --not-a-real-argument "Bob" greet: Unrecognized argument: --not-a-real-argument -Usage: greet [--help] <name> [--be-excited] +Signature: greet [--help] <name> [--be-excited] ``` Underscores in argument names are converted to dashes when parsing command line @@ -88,13 +88,13 @@ enum Foo(One, Two, Three) func main(foo:Foo): >> foo -# Usage: +# Signature: $ tomo foo.tm one >> Foo.One $ tomo foo.tm xxx foo: Invalid value provided for --foo; valid values are: One Two -Usage: foo [--help] <foo> +Signature: foo [--help] <foo> ``` ### Arrays of Text |