From bac78c5a6a44027eb2b4307e2a2f9bcc687675fd Mon Sep 17 00:00:00 2001 From: Tomoya Fujita Date: Sun, 9 Mar 2025 17:19:52 -0700 Subject: [PATCH] codespell ROS 2 documentation dictionary support. (#5058) * codespell ROS 2 documentation dictionary support. Signed-off-by: Tomoya Fujita * add more ROS specific words in the dictionary. Signed-off-by: Tomoya Fujita --------- Signed-off-by: Tomoya Fujita (cherry picked from commit 1a56306909a0602eb036b96b34c55d08bfdfb73f) --- codespell.cfg | 3 +++ codespell_dictionary.txt | 20 ++++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 codespell_dictionary.txt diff --git a/codespell.cfg b/codespell.cfg index e34631dee88..3debfca9156 100644 --- a/codespell.cfg +++ b/codespell.cfg @@ -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, diff --git a/codespell_dictionary.txt b/codespell_dictionary.txt new file mode 100644 index 00000000000..fe5d37686e1 --- /dev/null +++ b/codespell_dictionary.txt @@ -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