automatic spelling check by sphinx-spelling ext.#4998
automatic spelling check by sphinx-spelling ext.#4998fujitatomoya wants to merge 1 commit intorollingfrom
Conversation
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
| spelling_ignore_acronyms = True | ||
| spelling_ignore_case = True | ||
| spelling_ignore_digits = True |
There was a problem hiding this comment.
according to the result with this repo, these configurations do not really help to reduce the warnings.
|
HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/13172711320/artifacts/2545492862. To view the resulting site:
|
|
Are there any discussions of starting a pre-commit check on this repo? There are some other things (including sentences) that we might want to put in there. |
i thought about that too. my concern is what if that is the false alarm? that is gonna block the user right there even if that is NOT related to their fix... besides, this is gonna be really hard for them to ask for help, because it is locally happening? |
|
I will go ahead to close this one for now, instead we can enhance codespell dictionary. |
related to #4997
i tried another approach with
sphinxcontrib.spelling, that i knew that is going to be aggressive to detect possible misspelling...although this works as framework, this generates much more burden to maintain the whitelist and false alarms... i am not gonna suggest this approach at this moment...