summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorOmar Flores <47699779+yoyojambo@users.noreply.github.com>2022-03-26 02:56:10 -0600
committerGitHub <noreply@github.com>2022-03-26 09:56:10 +0100
commit86e93eb2938329db921d5edb718fa7f3ecee83b1 (patch)
treeb0f83573e218e134d41dd576e30684154795b6f1
parent84ac0035190e81cb991544460786bd5618386bec (diff)
downloadNim-86e93eb2938329db921d5edb718fa7f3ecee83b1.tar.gz
Fixed description as option in advopt.txt (#19635)
* Fixed formatting error in warningAsError.

There was only a single space character between the warning and its description, so it shows up as part of the name (in bold) and with no description.
Copied the way hotCodeReloading was formatted, with the description in a new line.

Also changed descriptions from 'ditto' to what the description it references says.

* Fixed typo in advopt.txt

Corrected 'hints' to 'warnings' in updated advopt.txt.
-rw-r--r--doc/advopt.txt10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/advopt.txt b/doc/advopt.txt
index 0a2349597..244fe035b 100644
--- a/doc/advopt.txt
+++ b/doc/advopt.txt
@@ -55,9 +55,13 @@ Advanced options:
                             (only `all:off` is supported).
   --hintAsError:X:on|off    turn specific hint X into an error on|off
   -w:on|off|list, --warnings:on|off|list
-                            same as `--hints` but for warnings.
-  --warning:X:on|off        ditto
-  --warningAsError:X:on|off ditto
+                            `on|off` enables or disables warnings.
+                            `list` reports which warnings are selected.
+  --warning:X:on|off        turn specific warning X on|off. `warning:X` means `warning:X:on`,
+                            as with similar flags. `all` is the set of all warning
+                            (only `all:off` is supported).
+  --warningAsError:X:on|off
+                            turn specific warning X into an error on|off
   --styleCheck:off|hint|error
                             produce hints or errors for Nim identifiers that
                             do not adhere to Nim's official style guide