Sentence checker (backport #4592)#5089
Merged
christophebedard merged 4 commits intohumblefrom Mar 14, 2025
Merged
Conversation
* 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 <Tomoya.Fujita@sony.com> * 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 <christophe.bedard@apex.ai> * remove --break-system-packages and address docker build warnings. (#5021) * remove --break-system-packages and address docker build warnings. Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com> * add github workflow to test Dockerfile. Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com> * Revert "add github workflow to test Dockerfile." This reverts commit 8686f18. Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com> --------- Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com> * 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 <Tomoya.Fujita@sony.com> * Update Using-Node-Interfaces-Template-Class.rst (#5038) Added missing ``Output:`` before the terminal output for consistency reasons Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com> * 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 <Tomoya.Fujita@sony.com> Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com> * Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com> * Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com> * Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com> Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com> * Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com> Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com> * Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com> Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com> * Update source/Tutorials/Intermediate.rst Thanks for pointing it out, I didnt notice the extention beeing there Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com> Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com> * Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com> Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com> --------- Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com> Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com> Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com> * 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 <shane.loretz@gmail.com> * Wrap r2d2.rviz in backticks Signed-off-by: Shane Loretz <sloretz@intrinsic.ai> * Wrap URL in RST link Signed-off-by: Shane Loretz <sloretz@intrinsic.ai> * Add empty line after section title Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com> Signed-off-by: Shane Loretz <shane.loretz@gmail.com> * Add empty line after section title Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com> Signed-off-by: Shane Loretz <shane.loretz@gmail.com> * Use normalized project name sphinx-tamer Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> Signed-off-by: Shane Loretz <shane.loretz@gmail.com> * Make sentence checker ignore `.idl` Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> Signed-off-by: Shane Loretz <shane.loretz@gmail.com> --------- Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com> Signed-off-by: Christophe Bedard <christophe.bedard@apex.ai> Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com> Signed-off-by: Shane Loretz <shane.loretz@gmail.com> Signed-off-by: Shane Loretz <sloretz@intrinsic.ai> Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> Co-authored-by: Christophe Bedard <christophe.bedard@apex.ai> Co-authored-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com> Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com> Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com> Co-authored-by: Shane Loretz <shane.loretz@gmail.com> Co-authored-by: Shane Loretz <sloretz@intrinsic.ai> (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
Contributor
Author
|
Cherry-pick of 784fd45 has failed: 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 |
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Collaborator
|
@DLu please review this one too. |
|
HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/13865464784/artifacts/2755726820. To view the resulting site:
|
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
99d08a0 to
056661a
Compare
Collaborator
|
@christophebedard i addressed your comments, can you check and merge? |
christophebedard
approved these changes
Mar 14, 2025
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
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.
And now, a reading from the book of Code Style
@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.