Spellchecker doesn't ignore labels and types in autodoc docstrings #10187
Labels
Enhancement ✨
Improvement to a component
Needs PR
This issue is accepted, sufficiently specified and now needs an implementation
Current problem
There are a few styles of these (Google, Numpy) but the project I'm working on uses a style like this. I guess this would be Sphinx style?
arg
,rtype
,str
all come up as spelling errors. InterestinglyOrderedDict
doesn't unless I specify it ascollections.OrderedDict
The current workaround it to add these to the ignored words list or private dictionary, but that can potentially lead to masking other spelling errors. The bigger issue is this creates resistance to using the spell checker, especially with those who aren't used to it.
Desired solution
The spell checker should be able to recognize these cases and ignore them, but not ignore the the description text to the right. Potentially this could be configurable like
spelling-ignore-comment-directives
, but these styles don't change at the frequency of new tools being introduced.Additional context
No response
The text was updated successfully, but these errors were encountered: