Corrected Typos and Grammatical inconsistencies in Documentation #1304
Conversation
… grammatical corrections
|
@AtsushiSakai Let me know if you wish to go ahead with this change as well. |
|
@codex review |
There was a problem hiding this comment.
Pull Request Overview
This PR addresses issue #1303 by correcting various typographical and grammatical errors throughout the documentation to improve readability and accuracy. The corrections span multiple documentation files covering robotics concepts from arm navigation to SLAM implementations, fixing issues ranging from simple article misuse ("a" vs "an") to more critical errors in mathematical notation that could cause confusion.
Key changes:
- Corrected grammatical errors including article usage ("a interactive" → "an interactive") and verb forms ("minimize" → "minimizes")
- Fixed spelling mistakes in technical terms (e.g., "accellation" → "acceleration", "Vornoi" → "Voronoi")
- Corrected mathematical notation errors in equations that could lead to misinterpretation
Reviewed Changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/modules/7_arm_navigation/planar_two_link_ik_main.rst | Corrected article usage from "a interactive" to "an interactive" |
| docs/modules/7_arm_navigation/n_joint_arm_to_point_control_main.rst | Corrected article usage from "a interactive" to "an interactive" |
| docs/modules/6_path_tracking/move_to_a_pose/move_to_a_pose_main.rst | Fixed typo "instantiate" to "instance" |
| docs/modules/6_path_tracking/model_predictive_speed_and_steering_control/model_predictive_speed_and_steering_control_main.rst | Corrected multiple spelling and grammar errors in MPC documentation |
| docs/modules/5_path_planning/vrm_planner/vrm_planner_main.rst | Fixed spelling "Vornoi" to "Voronoi" |
| docs/modules/5_path_planning/reeds_shepp_path/reeds_shepp_path_main.rst | Corrected spelling errors "respresent" and "requried" |
| docs/modules/5_path_planning/grid_base_search/grid_base_search_main.rst | Fixed punctuation in "Theta*" reference |
| docs/modules/5_path_planning/elastic_bands/elastic_bands_main.rst | Corrected grammatical error in mathematical explanation |
| docs/modules/5_path_planning/dubins_path/dubins_path_main.rst | Fixed grammatical error in segment type description |
| docs/modules/4_slam/graph_slam/graphSLAM_doc.rst | Corrected "least square" to "least squares" and fixed mathematical variable notation |
| docs/modules/4_slam/ekf_slam/ekf_slam_main.rst | Fixed typo in coordinate notation from "x_y" to "y_2" |
| docs/modules/4_slam/FastSLAM1/FastSLAM1_main.rst | Corrected spelling errors "srate" and "reseampling" |
| docs/modules/3_mapping/lidar_to_grid_map_tutorial/lidar_to_grid_map_tutorial_main.rst | Fixed grammatical error in sentence structure |
| docs/modules/2_localization/particle_filter_localization/particle_filter_localization_main.rst | Corrected subject-verb agreement from "This measurements" to "These measurements" |
| docs/modules/2_localization/histogram_filter_localization/histogram_filter_localization_main.rst | Fixed spelling "noize" to "noise" |
| docs/modules/1_introduction/3_technologies_for_robotics/technologies_for_robotics_main.rst | Corrected verb form from "focus" to "focuses" |
| docs/modules/1_introduction/2_python_for_robotics/python_for_robotics_main.rst | Fixed spelling "programing" to "programming" |
| docs/modules/13_mission_planning/behavior_tree/behavior_tree_main.rst | Corrected verb forms and pluralization |
| docs/modules/12_appendix/Kalmanfilter_basics_main.rst | Fixed contraction "does'nt" to "doesn't" |
| docs/modules/10_inverted_pendulum/inverted_pendulum_main.rst | Added missing word and corrected verb form |
| docs/modules/0_getting_started/3_how_to_contribute_main.rst | Fixed typo "you" to "your" |
| docs/modules/0_getting_started/2_how_to_run_sample_codes_main.rst | Corrected spelling "Extented" to "Extended" |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Codex Review: Didn't find any major issues. Already looking forward to the next diff. ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
2 participants
Reference issue
Fixes #1303
What does this implement/fix?
Corrects various typos and grammatical errors for improved readability and quality of documentation. Note that some typos were in mathematical equations which could previously have led to erroneous interpretations/confusion.
CheckList