Fix typos, spelling errors, and factual issues in documentation - #32
Merged
Conversation
- index.rst: Fix subject-verb agreement ('code have' -> 'code has', 'compatibility have' -> 'compatibility has')
- index.rst: Fix misspelling 'librarys' -> 'libraries', adjust pronoun 'it' -> 'them'
- inspecting_topics.rst: Fix typo 'was though by' -> 'was thought by' (2 occurrences)
- installation.rst: Fix misspelling 'derivates' -> 'derivatives'
- parameters_and_launch.rst: Fix incorrect package name 'packages_with_interfaces' -> 'package_with_interfaces'
- publishers_and_subscribers.rst: Fix incorrect package name 'packages_with_interfaces' -> 'package_with_interfaces'
- transformations/index.rst: Fix incorrect message type 'TransformedStamped' -> 'TransformStamped'
- inspecting_services.rst: Fix grammar 'it's own' -> 'its own'
- source_after_build.rst: Fix ambiguous word 'resource' -> 're-source'
- transformations/tf2.rst: Fix grammar 'subscribers to not' -> 'subscribers do not'
- Replace 26 instances of deprecated .. code :: with .. code-block :: - Standardize sub-subsection underlines: convert ^ and ~ to + (22 lines across 6 files) - Fix 9 section underline length mismatches - Fix 2 broken .. note: directives (missing ::) - Fix 1 extra space in .. code-block:: directive - Add missing trailing newlines to 13 files - Remove trailing whitespace from all RST files - Standardize :download: labels to use only the filename
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR fixes 11 typos, spelling errors, and factual issues found across the documentation source files. These issues could confuse readers following the tutorial, especially the incorrect package names and message type references.
Changes
Spelling fixes
docs/source/index.rstdocs/source/installation.rstdocs/source/inspecting_topics.rstdocs/source/transformations/index.rstGrammar fixes
docs/source/index.rstdocs/source/index.rstdocs/source/inspecting_services.rstdocs/source/transformations/tf2.rstdocs/source/source_after_build.rstFactual fixes (incorrect package name)
docs/source/parameters_and_launch.rstdocs/source/publishers_and_subscribers.rstSeverity
packages_with_interfaces→package_with_interfaces) and message type (TransformedStamped→TransformStamped) could mislead learners following the tutorial step by step.This PR was created by an AI agent (OpenHands) on behalf of the user.