Merge pull request #118 from dhellmann/release-note-warning-option

add release note for `spelling_warning` option
sphinx-contrib · Nov 5, 2020 · 7612743 · 7612743
2 parents aa5971d + 1704c57
commit 7612743
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/source/customize.rst b/docs/source/customize.rst
@@ -35,6 +35,8 @@ Input Options
 .. _PyEnchant tutorial: https://github.com/rfk/pyenchant/blob/master/website/content/tutorial.rst
 .. _exclude_patterns : https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-exclude_patterns
 
+.. _output-options:
+
 Output Options
 ==============
 

diff --git a/docs/source/history.rst b/docs/source/history.rst
@@ -6,6 +6,20 @@
 
    unmaintained
 
+7.1.0
+=====
+
+New Features
+------------
+
+- `#116 <https://github.com/sphinx-contrib/spelling/pull/116>`__ adds
+  a config option `spelling_warning` that makes individual messages
+  about misspellings warnings. The same change also updates the
+  formatting of the message to make it easier for IDEs to parse,
+  allowing the editor to navigate to the location of the misspelled
+  word. See :ref:`output-options` for details.  Contributed by Robert
+  Cohn.
+
 7.0.1
 =====