pylint.checkers.spelling

module documentation
(source)

Checker for spelling errors in comments and docstrings.

Class CamelCasedWord Filter skipping over camelCasedWords. This filter skips any words matching the following regular expression:
Class ForwardSlashChunker This chunker allows splitting words like 'before/after' into 'before' and 'after'.
Class RegExFilter Parent class for filters using regular expressions.
Class SpellingChecker Check spelling in comments and docstrings.
Class SphinxDirectives Filter skipping over Sphinx Directives. This filter skips any words matching the following regular expression:
Class WordsWithDigitsFilter Skips words with digits.
Class WordsWithUnderscores Skips words with underscores.
Function register Undocumented
Constant CODE_FLANKED_IN_BACKTICK_REGEX Undocumented
Constant PYENCHANT_AVAILABLE Undocumented
Variable enchant_dicts Undocumented
Function _get_enchant_dict_choices Undocumented
Function _get_enchant_dict_help Undocumented
Function _get_enchant_dicts Undocumented
Function _strip_code_flanked_in_backticks Alter line so code flanked in back-ticks is ignored.
def register(linter: PyLinter): (source)

Undocumented

CODE_FLANKED_IN_BACKTICK_REGEX = (source)

Undocumented

Value
re.compile(r'(\s|^)(`{1,2})([^`]+)(\2)([^`]|$)')
PYENCHANT_AVAILABLE: bool = (source)

Undocumented

Value
True
enchant_dicts = (source)

Undocumented

def _get_enchant_dict_choices(inner_enchant_dicts: list[tuple[Any, enchant.ProviderDesc]]) -> list[str]: (source)

Undocumented

def _get_enchant_dict_help(inner_enchant_dicts: list[tuple[Any, enchant.ProviderDesc]], pyenchant_available: bool) -> str: (source)

Undocumented

def _get_enchant_dicts() -> list[tuple[Any, enchant.ProviderDesc]]: (source)

Undocumented

def _strip_code_flanked_in_backticks(line: str) -> str: (source)

Alter line so code flanked in back-ticks is ignored. Pyenchant automatically strips back-ticks when parsing tokens, so this cannot be done at the individual filter level.