add verbose in the doc

sphinx-contrib · Apr 29, 2021 · 5d36685 · 5d36685
1 parent 0151317
commit 5d36685
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/docs/source/customize.rst b/docs/source/customize.rst
@@ -54,6 +54,10 @@ Output Options
   Boolean controlling whether a misspelling is emitted as a sphinx
   warning or as an info message. Defaults to False.
 
+``spelling_verbose=True``
+
+  Choose whether or not the mispelled output should be displayed in the terminal. Defaults to True.
+
 Word Filters
 ============
 

diff --git a/sphinxcontrib/spelling/__init__.py b/sphinxcontrib/spelling/__init__.py
@@ -54,7 +54,7 @@ def setup(app):
     app.add_config_value('spelling_filters', [], 'env')
     # Set a user-provided list of files to ignore
     app.add_config_value('spelling_exclude_patterns', [], 'env')
-    # Choose wether or not the misspel output should be displayed in the terminal 
+    # Choose whether or not the mispelled output should be displayed in the terminal 
     app.add_config_value('spelling_verbose', True, 'env')
     return {
         "parallel_read_safe": True,