| Joey Armstrong | 342430f | 2024-04-10 10:36:34 -0400 | [diff] [blame^] | 1 | LINT: Spelling exclusions |
| 2 | ========================= |
| 3 | |
| 4 | Correct spelling problems within docs whenever possible but on occasions |
| 5 | when commands or error message strings are in the dictionary exclusions |
| 6 | can be added |
| 7 | |
| 8 | .. code:: bash |
| 9 | |
| 10 | % make spelling |
| 11 | |
| 12 | Spelling exclusion for a special string |
| 13 | --------------------------------------- |
| 14 | |
| 15 | - Ignore this `` :spelling:ignore:`bogus-word` `` |
| 16 | - Quoting: ``item`` |
| 17 | |
| 18 | Spelling exclusions by list |
| 19 | --------------------------- |
| 20 | |
| 21 | Exclude `foo, bar & tans` within a single document. |
| 22 | .. code:: bash |
| 23 | |
| 24 | `` .. spelling:: `` |
| 25 | foo |
| 26 | bar |
| 27 | tans |
| 28 | |
| 29 | .. seealso:: |
| 30 | |
| 31 | [managing-lists-of-correctly-spelled-words-and-ignoring-words](https://sphinxcontrib-spelling.readthedocs.io/en/latest/customize.html#managing-lists-of-correctly-spelled-words-and-ignoring-words) |