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

Jump to bottom
Merged
merged 2 commits into from
Mar 10, 2025
Merged

codespell ROS 2 documentation dictionary support. #5058

merged 2 commits into from
Mar 10, 2025
+23 −0

Conversation

fujitatomoya
Copy link
Collaborator

@fujitatomoya fujitatomoya commented Feb 27, 2025 •
edited
Loading

part of #5004

@github-actions GitHub Actions
Copy link

github-actions bot commented Feb 27, 2025 •
edited
Loading

HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/13753967070/artifacts/2719184116.

To view the resulting site:

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

kscottz
kscottz approved these changes Mar 7, 2025
View reviewed changes
Copy link
Collaborator

@kscottz kscottz left a comment

Choose a reason for hiding this comment

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

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.

@fujitatomoya fujitatomoya force-pushed the fujitatomoya/codespell-dictionary-support branch from b0cf08e to 1525285 Compare March 10, 2025 00:13
@fujitatomoya fujitatomoya marked this pull request as ready for review March 10, 2025 00:13
@fujitatomoya
Copy link
Collaborator Author

@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 ROS2 -> ROS 2 check via codespell. (actually i was trying to fix this in the 1st place with this PR.) for doing this, we need a new feature to ignore the words in a case-sensitive manner for codespell, that i already developed codespell-project/codespell#3658 and waiting for review. after this PR is merged in codespell, we can check ROS2 but ros2 with suggestion ROS 2. i will keep tracking this one with #5004.

@fujitatomoya fujitatomoya merged commit 1a56306 into rolling Mar 10, 2025
5 checks passed
@fujitatomoya fujitatomoya deleted the fujitatomoya/codespell-dictionary-support branch March 10, 2025 00:19
@fujitatomoya fujitatomoya added the backport-all backport at reviewers discretion; from rolling to all versions label Mar 10, 2025
mergify bot pushed a commit that referenced this pull request Mar 10, 2025
@fujitatomoya @mergify
codespell ROS 2 documentation dictionary support. (#5058)
bac78c5 
* codespell ROS 2 documentation dictionary support.

Signed-off-by: Tomoya Fujita <[email protected]>

* add more ROS specific words in the dictionary.

Signed-off-by: Tomoya Fujita <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>
(cherry picked from commit 1a56306)
@mergify mergify bot mentioned this pull request Mar 10, 2025
Merged
mergify bot pushed a commit that referenced this pull request Mar 10, 2025
@fujitatomoya @mergify
codespell ROS 2 documentation dictionary support. (#5058)
eb2b556 
* codespell ROS 2 documentation dictionary support.

Signed-off-by: Tomoya Fujita <[email protected]>

* add more ROS specific words in the dictionary.

Signed-off-by: Tomoya Fujita <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>
(cherry picked from commit 1a56306)
@mergify mergify bot mentioned this pull request Mar 10, 2025
Merged
fujitatomoya added a commit that referenced this pull request Mar 10, 2025
@mergify @fujitatomoya
codespell ROS 2 documentation dictionary support. (#5058) (#5074)
927f1c6 
* codespell ROS 2 documentation dictionary support.

Signed-off-by: Tomoya Fujita <[email protected]>

* add more ROS specific words in the dictionary.

Signed-off-by: Tomoya Fujita <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>
(cherry picked from commit 1a56306)

Co-authored-by: Tomoya Fujita <[email protected]>
fujitatomoya added a commit that referenced this pull request Mar 10, 2025
@mergify @fujitatomoya
codespell ROS 2 documentation dictionary support. (#5058) (#5073)
1704958 
* codespell ROS 2 documentation dictionary support.

Signed-off-by: Tomoya Fujita <[email protected]>

* add more ROS specific words in the dictionary.

Signed-off-by: Tomoya Fujita <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>
(cherry picked from commit 1a56306)

Co-authored-by: Tomoya Fujita <[email protected]>
@fujitatomoya fujitatomoya mentioned this pull request Mar 10, 2025
Closed
@fujitatomoya
Copy link
Collaborator Author

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.

@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 😄

@kscottz
Copy link
Collaborator

kscottz commented Mar 10, 2025

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

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

@kscottz kscottz kscottz approved these changes

Assignees
No one assigned
Labels
backport-all backport at reviewers discretion; from rolling to all versions
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@fujitatomoya @kscottz