automatic spelling check by sphinx-spelling ext. #4998
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Tomoya Fujita <[email protected]>
fujitatomoya
commented
Feb 6, 2025
Comment on lines
+92
to
+94
| 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:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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...