Skip to content

codespell ROS 2 documentation dictionary support. #5058

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 10, 2025
Merged

codespell ROS 2 documentation dictionary support. #5058

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d99afb
codespell ROS 2 documentation dictionary support.
fujitatomoya Feb 27, 2025
1525285
add more ROS specific words in the dictionary.
fujitatomoya Mar 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions codespell.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ builtin = clear,rare,informal,code
# Ignore words listed in this file.
ignore-words = codespell_whitelist.txt

# Add ROS 2 custom dictionary file.
dictionary = codespell_dictionary.txt

# Skip checking files in this directory.
# This folder is ignored for a couple of reasons.
# *-Changelog.rst files are generated by commit history that could include some misspellings,
Expand Down
20 changes: 20 additions & 0 deletions codespell_dictionary.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
amnet->ament
amemt->ament
amentt->ament
catikn->catkin
catin->catkin
caktin->catkin
colcno->colcon
colcn->colcon
colcom->colcon
colconb->colcon
colconm->colcon
rosabg->rosbag
rosbagg->rosbag
rosbg->rosbag
rosbg2->rosbag2
rosbgz->rosbag
rosdist->rosdistro
rosdistr->rosdistro
rosdistroy->rosdistro
rosditro->rosdistro