codespell ROS 2 documentation dictionary support.#5058
Conversation
|
HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/13753967070/artifacts/2719184116. To view the resulting site:
|
kscottz
left a comment
There was a problem hiding this comment.
Short and sweet. It is probably better that way. Once I have something concrete to point at it might be easier for users to submit their suggestions.
Did we document this functionality? I can file a ticket for documentation of the codespell dictionary to land here. That's a really easy feature for a GSoC student to add.
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
b0cf08e to
1525285
Compare
|
@kscottz thanks for the review. I will make sure github workflow comes all green, and merge this now. after this PR is merged, we can add/remove the words for the ROS codespell dictionaries easily. there is one thing left about |
* codespell ROS 2 documentation dictionary support. Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com> * add more ROS specific words in the dictionary. Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com> --------- Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com> (cherry picked from commit 1a56306)
* codespell ROS 2 documentation dictionary support. Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com> * add more ROS specific words in the dictionary. Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com> --------- Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com> (cherry picked from commit 1a56306)
* codespell ROS 2 documentation dictionary support. Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com> * add more ROS specific words in the dictionary. Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com> --------- Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com> (cherry picked from commit 1a56306) Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
* codespell ROS 2 documentation dictionary support. Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com> * add more ROS specific words in the dictionary. Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com> --------- Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com> (cherry picked from commit 1a56306) Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
@kscottz i just created #5075, i am happy to support and review on this. please let me know if you need anything from my side 😄 |
|
@fujitatomoya looks like our new contributor is already on it. I now have a tracking spreadsheet for this stuff. I might wait for our new contributor to write the docs before I announce it. |
part of #5004