Skip to content

Other sentence formatting (backport #5031) #5033

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.

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

Merged
merged 2 commits into from
Feb 14, 2025

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Feb 14, 2025

In order to get automated tooling for one-sentence-per-line checking to work, I've had to make a few other edits that aren't just whitespace based.

  • Convert "eg." to "e.g."
  • Escape various file formats and commands, i.e. ".iso image" becomes ".iso image"
  • Change raw link texts to actual links.
  • Remove some added spurious periods just to limit corner cases.
  • Add a missing formatting block

cc: @fujitatomoya


This is an automatic backport of pull request #5031 done by Mergify.

* Add second dot to abbreviations
* Remove some random periods
* Escape some periods
* Convert some links
* Add formatted block

(cherry picked from commit 1975a31)

# Conflicts:
#	source/Tutorials/Demos/dummy-robot-demo.rst
@mergify mergify bot requested a review from clalancette as a code owner February 14, 2025 21:27
@mergify mergify bot added the conflicts label Feb 14, 2025
@mergify mergify bot requested a review from audrow as a code owner February 14, 2025 21:27
Copy link
Contributor Author

mergify bot commented Feb 14, 2025

Cherry-pick of 1975a31 has failed:

On branch mergify/bp/humble/pr-5031
Your branch is up to date with 'origin/humble'.

You are currently cherry-picking commit 1975a31.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   source/Concepts/Intermediate/About-Executors.rst
	modified:   source/How-To-Guides/Releasing/Release-Track.rst
	modified:   source/How-To-Guides/Releasing/_Bump-Package-Version.rst
	modified:   source/How-To-Guides/Releasing/_Install-Dependencies.rst
	modified:   source/The-ROS2-Project/Contributing/Build-Farms.rst
	modified:   source/The-ROS2-Project/Contributing/Code-Style-Language-Versions.rst
	modified:   source/The-ROS2-Project/Contributing/Developer-Guide.rst
	modified:   source/The-ROS2-Project/Feature-Ideas.rst
	modified:   source/Tutorials/Advanced/Allocator-Template-Tutorial.rst
	modified:   source/Tutorials/Advanced/Simulators/Webots/Installation-MacOS.rst
	modified:   source/Tutorials/Advanced/Simulators/Webots/Simulation-Supervisor.rst
	modified:   source/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.rst
	modified:   source/Tutorials/Demos/Quality-of-Service.rst
	modified:   source/Tutorials/Intermediate/Monitoring-For-Parameter-Changes-CPP.rst
	modified:   source/Tutorials/Intermediate/URDF/Adding-Physical-and-Collision-Properties-to-a-URDF-Model.rst
	modified:   source/Tutorials/Intermediate/URDF/Building-a-Visual-Robot-Model-with-URDF-from-Scratch.rst
	modified:   source/Tutorials/Miscellaneous/Building-Realtime-rt_preempt-kernel-for-ROS-2.rst
	modified:   source/Tutorials/Miscellaneous/Deploying-ROS-2-on-IBM-Cloud.rst
	modified:   source/Tutorials/Miscellaneous/Eclipse-Oxygen-with-ROS-2-and-rviz2.rst

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   source/Tutorials/Demos/dummy-robot-demo.rst

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

The content for Humble is a bit different. There are no tabs, and
there's already a code-block.

Signed-off-by: Christophe Bedard <[email protected]>
Copy link

HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/13337885719/artifacts/2595266924.

To view the resulting site:

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

@christophebedard christophebedard merged commit de7c7ed into humble Feb 14, 2025
5 checks passed
@christophebedard christophebedard deleted the mergify/bp/humble/pr-5031 branch February 14, 2025 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants