-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Closed
Labels
backport-allbackport at reviewers discretion; from rolling to all versionsbackport at reviewers discretion; from rolling to all versionsgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
Overview
automatic spell check has been added with #4997 and #5058 for ROS 2 documentation.
This issue is to add the documentation how to use automatic spell check, how to add/remove the words to/from the dictionaries. So that developers can run the spell check locally before opening the pull request, and we can also expect the users and developers can add more possible miss-spelling words to our ROS 2 specific dictionaries easily.
Consideration
- this doc could land around https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.html
- introduction how codespell works with ROS 2 documentation with ignore/miss-spell dictionaries.
- explain how to run spell check locally and fix them.
- explain how to add/remove the suggestions to the dictionaries.
Metadata
Metadata
Assignees
Labels
backport-allbackport at reviewers discretion; from rolling to all versionsbackport at reviewers discretion; from rolling to all versionsgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed