Skip to content

Commit

Permalink
Merge pull request #200 from dhellmann/doc-ignore-role
Browse files Browse the repository at this point in the history
update documentation for spelling:ignore role
  • Loading branch information
dhellmann committed Nov 13, 2022
2 parents 139596b + 4c3e1c6 commit 2cfe4c8
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 15 deletions.
15 changes: 11 additions & 4 deletions docs/source/customize.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down
16 changes: 5 additions & 11 deletions docs/source/history.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,15 @@
macOS
unmaintained

Unreleased
==========

Bug Fixes
---------

None.
7.7.0
=====

New Features
------------

- `#199 <https://github.com/sphinx-contrib/spelling/pull/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 <https://github.com/sphinx-contrib/spelling/pull/199>`__ Add
``spelling:ignore`` role for marking inline text to not be
checked. See :doc:`/customize` for more details.

7.6.2
=====
Expand Down

0 comments on commit 2cfe4c8

Please sign in to comment.