Skip to content
New issue

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

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

Already on GitHub? # to your account

address mistyping detected by codespell checker. #4980

Merged
merged 1 commit into from
Jan 30, 2025

Conversation

fujitatomoya
Copy link
Collaborator

@clalancette @kscottz Can I have some help here for review?

i think most of them are correct fixes, but sometimes there are multiple spelling... e.g ) indention vs indentation, codespell actually detects indention to be replaced with indentation. but it seems no need to do that...

Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
@fujitatomoya
Copy link
Collaborator Author

just a note, those are detected by using codespell as below, this PR fixes all of them.

  • empy, indention is assigned as ignored-workds-list.
  • i did not check the directory under source/Releases/, that includes names for authors and contributors, that compiles up the warnings.
rosindex@b773a231f186:/tmp/doc_repository$ git ls-files '*.md' '*.rst' | xargs codespell --ignore-words-list="empy,indention" --skip="source/Releases/*"
source/Concepts/Basic/About-Interfaces.rst:210: programatically ==> programmatically
source/Concepts/Basic/About-Topics.rst:17: entites ==> entities
source/Concepts/Intermediate/About-RQt.rst:59: infrastucture ==> infrastructure
source/Concepts/Intermediate/About-RQt.rst:75: maintainance ==> maintenance
source/How-To-Guides/Ament-CMake-Documentation.rst:344: addtional ==> additional
source/How-To-Guides/Core-maintainer-guide.rst:9: responsibile ==> responsible
source/How-To-Guides/Getting-Backtraces-in-ROS-2.rst:235: debbuging ==> debugging
source/How-To-Guides/Installation-Troubleshooting.rst:54: MULITCAST ==> MULTICAST
source/How-To-Guides/Installation-Troubleshooting.rst:245: failes ==> fails
source/How-To-Guides/Migrating-from-ROS1/Migrating-CPP-Packages.rst:112: pacakage ==> package
source/How-To-Guides/Migrating-from-ROS1/Migrating-Launch-Files.rst:317: decription ==> description, decryption
source/How-To-Guides/Migrating-from-ROS1/Migrating-Python-Package-Example.rst:488: Rplace ==> Replace
source/How-To-Guides/Migrating-from-ROS1/Migrating-Python-Package-Example.rst:810: convensions ==> conventions, conversions
source/How-To-Guides/Using-Variants.rst:4: convienent ==> convenient
source/How-To-Guides/Using-ros2-param.rst:67: heterogenous ==> heterogeneous
source/Installation/DDS-Implementations/Install-Connext-University-Eval.rst:22: Evalution ==> Evaluation, Evolution
source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst:189: coverts ==> converts, covers, covets
source/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.rst:205: documenation ==> documentation
source/The-ROS2-Project/Contributing/Developer-Guide.rst:209: Documetation ==> Documentation
source/The-ROS2-Project/ROSCon-Content.rst:119: Modelin ==> Modeling, Model in
source/Tutorials/Advanced/FastDDS-Configuration.rst:456: deafult ==> default
source/Tutorials/Advanced/Reading-From-A-Bag-File-CPP.rst:207: calback ==> callback
source/Tutorials/Advanced/Security/Access-Controls.rst:114: accoring ==> according, occurring
source/Tutorials/Advanced/Security/Deployment-Guidelines.rst:19: payed ==> paid
source/Tutorials/Advanced/Security/Deployment-Guidelines.rst:127: configration ==> configuration
source/Tutorials/Advanced/Security/Introducing-ros2-security.rst:83: mulitple ==> multiple
source/Tutorials/Advanced/Security/The-Keystore.rst:27: extrememly ==> extremely
source/Tutorials/Advanced/Security/The-Keystore.rst:28: managment ==> management
source/Tutorials/Advanced/Security/The-Keystore.rst:180: specifed ==> specified
source/Tutorials/Advanced/Security/The-Keystore.rst:184: mulitple ==> multiple
source/Tutorials/Advanced/Security/The-Keystore.rst:184: descibed ==> described
source/Tutorials/Beginner-CLI-Tools/Configuring-ROS2-Environment.rst:114: everytime ==> every time
source/Tutorials/Beginner-Client-Libraries/Using-Parameters-In-A-Class-Python.rst:302: tutoral ==> tutorial
source/Tutorials/Demos/Real-Time-Programming.rst:168: pre-empt ==> preempt
source/Tutorials/Intermediate/Monitoring-For-Parameter-Changes-CPP.rst:323: teminal ==> terminal
source/Tutorials/Intermediate/Monitoring-For-Parameter-Changes-Python.rst:319: teminal ==> terminal
source/Tutorials/Intermediate/RViz/RViz-User-Guide/RViz-User-Guide.rst:172: visualzation ==> visualization
source/Tutorials/Intermediate/Tf2/Quaternion-Fundamentals.rst:35: transfromation ==> transformation
source/Tutorials/Intermediate/URDF/Exporting-an-URDF-File.rst:40: respository ==> repository

@fujitatomoya fujitatomoya self-assigned this Jan 30, 2025
Copy link

HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/13043417505/artifacts/2507925678.

To view the resulting site:

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

@ahcorde ahcorde added the backport-all backport at reviewers discretion; from rolling to all versions label Jan 30, 2025
@ahcorde ahcorde merged commit 49f66fd into rolling Jan 30, 2025
4 checks passed
@ahcorde ahcorde deleted the fujitatomoya/codespell-typo-fixes branch January 30, 2025 17:14
mergify bot pushed a commit that referenced this pull request Jan 30, 2025
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
(cherry picked from commit 49f66fd)
mergify bot pushed a commit that referenced this pull request Jan 30, 2025
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
(cherry picked from commit 49f66fd)

# Conflicts:
#	source/Tutorials/Intermediate/Monitoring-For-Parameter-Changes-Python.rst
ahcorde pushed a commit that referenced this pull request Jan 30, 2025
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
(cherry picked from commit 49f66fd)

Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
ahcorde added a commit that referenced this pull request Jan 30, 2025
)

* address mistyping detected by codespell checker. (#4980)

Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
(cherry picked from commit 49f66fd)

Signed-off-by: Alejandro Hernandez Cordero <ahcorde@gmail.com>
Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Co-authored-by: Alejandro Hernandez Cordero <ahcorde@gmail.com>
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
backport-all backport at reviewers discretion; from rolling to all versions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants