Minor spelling fixes

Erotemic · Mar 25, 2022 · cfb4b4e · cfb4b4e
1 parent 999973e
commit cfb4b4e
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 26 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -51,7 +51,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
   pytest when a module errors while it is being imported before the doctest is
   run.
 * Pytest now defaults to `--xdoctest-verbose=2` by default (note this does
-  nothing unless `-s` is also given so pytest does not supress output)
+  nothing unless `-s` is also given so pytest does not suppress output)
 
 
 ## Version 0.15.7 - Yanked 
@@ -201,7 +201,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ### Changed
 * `PythonPathContext` now works in more corner cases, although some rarer
   corner cases will now break. This trade-off should be a net positive. 
-* Releases are handled by TravisCI and will be signed with the GPG key 98007794ED130347559354B1109AC852D297D757 (note we will rotate this key in 1 year). <- (2021-09-06) lol that did not happen, dsomeday I'll get around to setting up rotating GPG keys. 
+* Releases are handled by TravisCI and will be signed with the GPG key 98007794ED130347559354B1109AC852D297D757 (note we will rotate this key in 1 year). <- (2021-09-06) lol that did not happen, someday I'll get around to setting up rotating GPG keys. 
 
 
 ## [Version 0.10.0] - Released 2019-08-15
@@ -229,7 +229,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ### Changed 
 * Improved backwards compatibility. Explicit continuations now work more similarly to the original doctest. 
-* You no longer need a commend to denote that a `...` is a continuation and not a ellipsis.
+* You no longer need a comment to denote that a `...` is a continuation and not a ellipsis.
 * Want statements will check against return values in nested continuations
 
 ### Fixed

diff --git a/README.rst b/README.rst
@@ -98,7 +98,7 @@ future), you should also verify this agrees with the contents of
 ``dev/public_gpg_key``. 
 
 
-Usage: Run your Doctests
+Usage: run your doctests
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
 
@@ -337,7 +337,7 @@ backwards-compatible) syntax:
 
         """
 
-Xdoctest parsing style 
+Xdoctest Parsing Style 
 ----------------------
 
 There are currently two main doctest parsing styles: ``google`` and
@@ -364,7 +364,7 @@ pytest) which will pull all google-style blocks out as single doctests, while
 still all other ``>>>`` prefixed code out as a freeform doctest. 
 
 
-Notes on Got/Want tests
+Notes On Got/Want Tests
 -----------------------
 
 The new got/want tester is very permissive by default; it ignores

diff --git a/xdoctest/__init__.py b/xdoctest/__init__.py
@@ -196,43 +196,41 @@ def fib(n):
 
 .. code-block:: text
 
-    usage: xdoctest [-h] [--version] [-m MODNAME] [-c COMMAND] [--style {auto,google,freeform}] [--analysis {auto,static,dynamic}]
-                    [--durations DURATIONS] [--time] [--colored COLORED] [--nocolor] [--offset]
-                    [--report {none,cdiff,ndiff,udiff,only_first_failure}] [--options OPTIONS] [--global-exec GLOBAL_EXEC]
+    usage: xdoctest [-h] [--version] [-m MODNAME] [-c COMMAND] [--style {auto,google,freeform}] [--analysis {auto,static,dynamic}] [--durations DURATIONS] [--time]
+                    [--colored COLORED] [--nocolor] [--offset] [--report {none,cdiff,ndiff,udiff,only_first_failure}] [--options OPTIONS] [--global-exec GLOBAL_EXEC]
                     [--verbose VERBOSE] [--quiet] [--silent]
-                    [arg [arg ...]]
+                    [arg ...]
 
-    Xdoctest 0.15.0 - on Python - 3.8.3 (default, Jul  2 2020, 16:21:59)
-    [GCC 7.3.0] - discover and run doctests within a python package
+    Xdoctest 1.0.0 - on Python - 3.9.9 (main, Jan  6 2022, 18:33:12)
+    [GCC 10.3.0] - discover and run doctests within a python package
 
     positional arguments:
-      arg                   Ignored if optional arguments are specified, otherwise: Defaults --modname to arg.pop(0). Defaults --command
-                            to arg.pop(0). (default: None)
+      arg                   Ignored if optional arguments are specified, otherwise: Defaults --modname to arg.pop(0). Defaults --command to arg.pop(0). (default: None)
 
     optional arguments:
       -h, --help            show this help message and exit
-      --version             display version info and quit (default: False)
+      --version             Display version info and quit (default: False)
       -m MODNAME, --modname MODNAME
-                            module name or path. If specified positional modules are ignored (default: None)
+                            Module name or path. If specified positional modules are ignored (default: None)
       -c COMMAND, --command COMMAND
-                            a doctest name or a command (list|all|<callname>). Defaults to all (default: None)
+                            A doctest name or a command (list|all|<callname>). Defaults to all (default: None)
       --style {auto,google,freeform}
-                            choose the style of doctests that will be parsed (default: auto)
+                            Choose the style of doctests that will be parsed (default: auto)
       --analysis {auto,static,dynamic}
-                            How doctests are collected (default: static)
+                            How doctests are collected (default: auto)
       --durations DURATIONS
-                            specify execution times for slowest N tests.N=0 will show times for all tests (default: None)
+                            Specify execution times for slowest N tests.N=0 will show times for all tests (default: None)
       --time                Same as if durations=0 (default: False)
       --colored COLORED     Enable or disable ANSI coloration in stdout (default: True)
       --nocolor             Disable ANSI coloration in stdout
-      --offset              if True formatted source linenumbers will agree with their location in the source file. Otherwise they will
-                            be relative to the doctest itself. (default: False)
+      --offset              If True formatted source linenumbers will agree with their location in the source file. Otherwise they will be relative to the doctest itself. (default:
+                            False)
       --report {none,cdiff,ndiff,udiff,only_first_failure}
-                            choose another output format for diffs on xdoctest failure (default: udiff)
-      --options OPTIONS     default directive flags for doctests (default: None)
+                            Choose another output format for diffs on xdoctest failure (default: udiff)
+      --options OPTIONS     Default directive flags for doctests (default: None)
       --global-exec GLOBAL_EXEC
-                            exec these lines before every test (default: None)
-      --verbose VERBOSE     verbosity level (default: 3)
+                            Custom Python code to execute before every test (default: None)
+      --verbose VERBOSE     Verbosity level. 0 is silent, 1 prints out test names, 2 additionally prints test stdout, 3 additionally prints test source (default: 3)
       --quiet               sets verbosity to 1
       --silent              sets verbosity to 0