Skip to content

Sentence checker (backport #4592) #5089

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 4 commits into from
Mar 14, 2025
Merged

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Mar 13, 2025

And now, a reading from the book of Code Style

Each sentence must start on a new line.

@clalancette is a real stickler for this, so I made a linter. Unfortunately, there are lots of problems, some of which are the linter, and some of which are the content.

Happy to have help. I can't devote a ton more time to this, but I still wanted the code to be out there.


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

* Sentence Checker

* Some edits

* Update About-Executors.rst

* More sentence breaks

* More cleanup

* More sentences

* Fix smart quotes

* fix group tag indent for ROSCon 2023 and 2024 contents. (#5016)

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

* Clean up sentences II (white space changes only) (#5017)

* Exclude literals parts from bold parts in 'Ament Lint CLI Utilities' (#5024)

You can't do nested inline markup in RST:

**Can't do ``this`` in RST.**

The simplest solution is to just exclude the ``literal`` part.

Also, do some other minor fixes.

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

* remove --break-system-packages and address docker build warnings. (#5021)

* remove --break-system-packages and address docker build warnings.

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

* add github workflow to test Dockerfile.

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

* Revert "add github workflow to test Dockerfile."

This reverts commit 8686f18.

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

---------

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

* More

* Other sentence formatting (#5031)

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

* Enable github/workflow to verify Dockerfile. (#5035)

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

* Update Using-Node-Interfaces-Template-Class.rst (#5038)

Added missing ``Output:`` before the terminal output for consistency reasons

Signed-off-by: Nikos Tziaros <[email protected]>

* added Publishing-Messages-Using-YAML-Files.rst and edited Intermediat… (#5034)

* added Publishing-Messages-Using-YAML-Files.rst and edited Intermediate.rst

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate.rst

Thanks for pointing it out, I didnt notice the extention beeing there

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

---------

Signed-off-by: Nikos Tziaros <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>

* more bits

* Some rollbacks

* Ignore

* Use sphinx_tamer

* More Sphinx Config

* Updated checker using subprocess

* Make sphinx-lint-with-ros exit with non-zero error codes

Signed-off-by: Shane Loretz <[email protected]>

* Wrap r2d2.rviz in backticks

Signed-off-by: Shane Loretz <[email protected]>

* Wrap URL in RST link

Signed-off-by: Shane Loretz <[email protected]>

* Add empty line after section title

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Add empty line after section title

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Use normalized project name sphinx-tamer

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Make sentence checker ignore `.idl`

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>
Signed-off-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>
Co-authored-by: Nikos Tziaros <[email protected]>
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>
Co-authored-by: Shane Loretz <[email protected]>
Co-authored-by: Shane Loretz <[email protected]>
(cherry picked from commit 784fd45)

# Conflicts:
#	source/Installation/Alternatives/RHEL-Development-Setup.rst
#	source/Installation/Alternatives/Windows-Development-Setup.rst
#	source/Installation/_rosdep_Linux_Mint.rst
Copy link
Contributor Author

mergify bot commented Mar 13, 2025

Cherry-pick of 784fd45 has failed:

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

You are currently cherry-picking commit 784fd45.
  (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:
	new file:   .sphinx_tamer.yaml
	modified:   Makefile
	new file:   plugins/ros_checkers.py
	modified:   requirements.txt
	modified:   source/Concepts/Intermediate/About-Executors.rst
	modified:   source/Contact.rst
	modified:   source/How-To-Guides/Documenting-a-ROS-2-Package.rst
	modified:   source/How-To-Guides/Migrating-from-ROS1/Migrating-Launch-Files.rst
	modified:   source/How-To-Guides/Releasing/Release-Track.rst
	modified:   source/How-To-Guides/Releasing/Releasing-a-Package.rst
	modified:   source/How-To-Guides/Using-Variants.rst
	modified:   source/Installation/Alternatives/RHEL-Install-Binary.rst
	modified:   source/Installation/DDS-Implementations.rst
	modified:   source/Installation/DDS-Implementations/Install-Connext-Security-Plugins.rst
	modified:   source/Installation/DDS-Implementations/Install-Connext-University-Eval.rst
	modified:   source/Installation/DDS-Implementations/Working-with-GurumNetworks-GurumDDS.rst
	modified:   source/Installation/RHEL-Install-RPMs.rst
	modified:   source/Installation/Windows-Install-Binary.rst
	modified:   source/Installation/_RHEL-Set-Locale.rst
	modified:   source/Installation/_Ubuntu-Set-Locale.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/Quality-Guide.rst
	modified:   source/The-ROS2-Project/ROSCon-Content.rst
	modified:   source/Tutorials/Advanced/Security/Introducing-ros2-security.rst
	modified:   source/Tutorials/Advanced/Simulators/Webots/Setting-Up-Simulation-Webots-Basic.rst
	modified:   source/Tutorials/Demos/Real-Time-Programming.rst
	modified:   source/Tutorials/Intermediate/Testing/Cpp.rst
	modified:   source/Tutorials/Intermediate/Testing/Integration.rst
	modified:   source/Tutorials/Intermediate/URDF/Using-URDF-with-Robot-State-Publisher-cpp.rst
	modified:   source/Tutorials/Miscellaneous/Building-Realtime-rt_preempt-kernel-for-ROS-2.rst
	modified:   source/index.rst
	new file:   sphinx-lint-with-ros

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   source/Installation/Alternatives/RHEL-Development-Setup.rst
	both modified:   source/Installation/Alternatives/Windows-Development-Setup.rst
	both modified:   source/Installation/_rosdep_Linux_Mint.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

@mergify mergify bot added the conflicts label Mar 13, 2025
Signed-off-by: Tomoya Fujita <[email protected]>
Signed-off-by: Tomoya Fujita <[email protected]>
@fujitatomoya
Copy link
Collaborator

@DLu please review this one too.

@fujitatomoya fujitatomoya self-assigned this Mar 14, 2025
Copy link

github-actions bot commented Mar 14, 2025

HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/13865464784/artifacts/2755726820.

To view the resulting site:

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

Signed-off-by: Tomoya Fujita <[email protected]>
@fujitatomoya
Copy link
Collaborator

@christophebedard i addressed your comments, can you check and merge?

@christophebedard christophebedard merged commit cddcd62 into humble Mar 14, 2025
5 checks passed
@christophebedard christophebedard deleted the mergify/bp/humble/pr-4592 branch March 14, 2025 21:31
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