From 4c3e1c6c526a3d2c8d83dd0896c5a901afa1f704 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Sun, 13 Nov 2022 10:28:42 -0500 Subject: [PATCH] update documentation for spelling:ignore role Acked-by: Doug Hellmann --- docs/source/customize.rst | 15 +++++++++++---- docs/source/history.rst | 16 +++++----------- 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/docs/source/customize.rst b/docs/source/customize.rst index cb5ccd8..1d976d1 100644 --- a/docs/source/customize.rst +++ b/docs/source/customize.rst @@ -131,8 +131,8 @@ returned by the tokenizer to be checked. derived from ``enchant.tokenize.Filter``. Refer to the `PyEnchant tutorial`_ for examples. -Private Dictionaries -==================== +Managing Lists of Correctly Spelled Words and Ignoring Words +============================================================ There are three ways to provide a list of known good words. The ``spelling_word_list_filename`` option (described above) specifies the @@ -161,13 +161,20 @@ can be added to the list of known words for just that document. Goodger The ``spelling:word`` role can be used to annotate individual words as -being spelled correctly. +being spelled correctly throughout a single document. :: This text refers to :spelling:word:`Goodger`. +The ``spelling:ignore`` role can be used to ignore a single instance +of a word. + +:: + + This text refers to :spelling:ignore:`docutils`. + .. _PyEnchant: https://github.com/rfk/pyenchant Custom Word Filters @@ -184,7 +191,7 @@ this :class:`AcronymFilter` skips words that are all uppercase letters or all uppercase with a trailing lowercase "s". :: - + class AcronymFilter(Filter): """If a word looks like an acronym (all upper case letters), ignore it. diff --git a/docs/source/history.rst b/docs/source/history.rst index 177ba2a..539cc74 100644 --- a/docs/source/history.rst +++ b/docs/source/history.rst @@ -9,21 +9,15 @@ macOS unmaintained -Unreleased -========== - -Bug Fixes ---------- - -None. +7.7.0 +===== New Features ------------ -- `#199 `__ -- Add ``spelling:ignore`` role for marking inline text to not be - checked. Allow single instances of misspelled words to be ignored, - but still flag any other instances as misspellings. +- `#199 `__ Add + ``spelling:ignore`` role for marking inline text to not be + checked. See :doc:`/customize` for more details. 7.6.2 =====