From 901763fc39f5342839d112876b843264cf866df8 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Sun, 5 Jun 2022 18:06:38 -0700 Subject: [PATCH] fix hyphens --- README.md | 26 +++++++++++++------------- templates/readme_template | 26 +++++++++++++------------- 2 files changed, 26 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index c32cdbee..ef33e42a 100644 --- a/README.md +++ b/README.md @@ -253,19 +253,19 @@ option. ### Options | Option | Description | |-----------------------|--------------------------------------------------------------------------------------------------------------| -| `‑a`, `‑‑about` | about `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | -| `‑C`, `‑‑force_color` | force color output even when using pipes (overrides `‑m` and the `NO_COLOR` env variable) | -| `‑d`, `‑‑debug` | debug mode. Prints trace messages if parsing issues are encountered (use`‑dd` for verbose debugging) | -| `‑h`, `‑‑help` | help. Use `jc ‑h ‑‑parser_name` for parser documentation | -| `‑m`, `‑‑monochrome` | monochrome output | -| `‑p`, `‑‑pretty` | pretty format the JSON output | -| `‑q`, `‑‑quiet` | quiet mode. Suppresses parser warning messages (use `‑qq` to ignore streaming parser errors) | -| `‑r`, `‑‑raw` | raw output. Provides more literal output, typically with string values and no additional semantic processing | -| `‑u`, `‑‑unbuffer` | unbuffer output | -| `‑v`, `‑‑version` | version information | -| `‑y`, `‑‑yaml‑out` | YAML output | -| `‑B`, `‑‑bash‑comp` | generate Bash shell completion script | -| `‑Z`, `‑‑zsh‑comp` | generate Zsh shell completion script | +| `-a`, `--about` | about `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | +| `-C`, `--force-color` | force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | +| `-d`, `--debug` | debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | +| `-h`, `--help` | help. Use `jc -h --parser_name` for parser documentation | +| `-m`, `--monochrome` | monochrome output | +| `-p`, `--pretty` | pretty format the JSON output | +| `-q`, `--quiet` | quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | +| `-r`, `--raw` | raw output. Provides more literal output, typically with string values and no additional semantic processing | +| `-u`, `--unbuffer` | unbuffer output | +| `-v`, `--version` | version information | +| `-y`, `--yaml-out` | YAML output | +| `-B`, `--bash-comp` | generate Bash shell completion script | +| `-Z`, `--zsh-comp` | generate Zsh shell completion script | ### Exit Codes Any fatal errors within `jc` will generate an exit code of `100`, otherwise the diff --git a/templates/readme_template b/templates/readme_template index 38bb61ab..3db0a4e1 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -151,19 +151,19 @@ option. ### Options | Option | Description | |-----------------------|--------------------------------------------------------------------------------------------------------------| -| `‑a`, `‑‑about` | about `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | -| `‑C`, `‑‑force_color` | force color output even when using pipes (overrides `‑m` and the `NO_COLOR` env variable) | -| `‑d`, `‑‑debug` | debug mode. Prints trace messages if parsing issues are encountered (use`‑dd` for verbose debugging) | -| `‑h`, `‑‑help` | help. Use `jc ‑h ‑‑parser_name` for parser documentation | -| `‑m`, `‑‑monochrome` | monochrome output | -| `‑p`, `‑‑pretty` | pretty format the JSON output | -| `‑q`, `‑‑quiet` | quiet mode. Suppresses parser warning messages (use `‑qq` to ignore streaming parser errors) | -| `‑r`, `‑‑raw` | raw output. Provides more literal output, typically with string values and no additional semantic processing | -| `‑u`, `‑‑unbuffer` | unbuffer output | -| `‑v`, `‑‑version` | version information | -| `‑y`, `‑‑yaml‑out` | YAML output | -| `‑B`, `‑‑bash‑comp` | generate Bash shell completion script | -| `‑Z`, `‑‑zsh‑comp` | generate Zsh shell completion script | +| `-a`, `--about` | about `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | +| `-C`, `--force-color` | force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | +| `-d`, `--debug` | debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | +| `-h`, `--help` | help. Use `jc -h --parser_name` for parser documentation | +| `-m`, `--monochrome` | monochrome output | +| `-p`, `--pretty` | pretty format the JSON output | +| `-q`, `--quiet` | quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | +| `-r`, `--raw` | raw output. Provides more literal output, typically with string values and no additional semantic processing | +| `-u`, `--unbuffer` | unbuffer output | +| `-v`, `--version` | version information | +| `-y`, `--yaml-out` | YAML output | +| `-B`, `--bash-comp` | generate Bash shell completion script | +| `-Z`, `--zsh-comp` | generate Zsh shell completion script | ### Exit Codes Any fatal errors within `jc` will generate an exit code of `100`, otherwise the