Skip to content

automatic spelling check by sphinx-spelling ext.#4998

Closed
fujitatomoya wants to merge 1 commit intorollingfrom
fujitatomoya/automatic-sphinx-spell-check
Closed

automatic spelling check by sphinx-spelling ext.#4998
fujitatomoya wants to merge 1 commit intorollingfrom
fujitatomoya/automatic-sphinx-spell-check

Conversation

@fujitatomoya
Copy link
Collaborator

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...

rosindex@08a1b9556c31:/tmp/doc_repository$ make spellcheck
...
Writing /tmp/doc_repository/build/spellcheck/index.spelling

WARNING: Found 10145 misspelled words
sphinx-sitemap-ros: No pages generated for sitemap.xml
build succeeded, 1 warning.

Check finished. Report is in build/spellcheck.```

Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Comment on lines +92 to +94
spelling_ignore_acronyms = True
spelling_ignore_case = True
spelling_ignore_digits = True
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

according to the result with this repo, these configurations do not really help to reduce the warnings.

@github-actions
Copy link

github-actions bot commented Feb 6, 2025

HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/13172711320/artifacts/2545492862.

To view the resulting site:

  1. Click on the above link to download the artifacts archive
  2. Extract it
  3. Open html-artifacts-4998/index.html in your favorite browser

@DLu
Copy link
Contributor

DLu commented Feb 14, 2025

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.

@DLu DLu mentioned this pull request Feb 14, 2025
@fujitatomoya
Copy link
Collaborator Author

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?

@fujitatomoya
Copy link
Collaborator Author

I will go ahead to close this one for now, instead we can enhance codespell dictionary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments