Skip to content

Other sentence formatting #5031

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 5 commits into from
Feb 14, 2025
Merged

Conversation

DLu
Copy link
Contributor

@DLu DLu 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

@christophebedard christophebedard added the backport-all backport at reviewers discretion; from rolling to all versions label Feb 14, 2025
@christophebedard christophebedard merged commit 1975a31 into ros2:rolling Feb 14, 2025
5 checks passed
mergify bot pushed a commit that referenced this pull request Feb 14, 2025
* Add second dot to abbreviations
* Remove some random periods
* Escape some periods
* Convert some links
* Add formatted block

(cherry picked from commit 1975a31)
mergify bot pushed a commit that referenced this pull request Feb 14, 2025
* 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
christophebedard pushed a commit that referenced this pull request Feb 14, 2025
* Add second dot to abbreviations
* Remove some random periods
* Escape some periods
* Convert some links
* Add formatted block

(cherry picked from commit 1975a31)

Co-authored-by: David V. Lu!! <[email protected]>
christophebedard pushed a commit that referenced this pull request Feb 14, 2025
* Other sentence formatting (#5031)

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

(cherry picked from commit 1975a31)

Signed-off-by: Christophe Bedard <[email protected]>
Co-authored-by: David V. Lu!! <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>
@DLu DLu mentioned this pull request Feb 18, 2025
DLu added a commit to DLu/ros2_documentation that referenced this pull request Feb 18, 2025
* Add second dot to abbreviations
* Remove some random periods
* Escape some periods
* Convert some links
* Add formatted block
fujitatomoya added a commit that referenced this pull request Mar 13, 2025
* 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]>
mergify bot pushed a commit that referenced this pull request Mar 13, 2025
* 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/Windows-Development-Setup.rst
mergify bot pushed a commit that referenced this pull request Mar 13, 2025
* 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
fujitatomoya added a commit that referenced this pull request Mar 14, 2025
* Sentence checker (#4592)

* 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/Windows-Development-Setup.rst

* resolve conflict.

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

* make linter happy.

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

---------

Signed-off-by: Tomoya Fujita <[email protected]>
Co-authored-by: David V. Lu!! <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
christophebedard pushed a commit that referenced this pull request Mar 14, 2025
* Sentence checker (#4592)

* 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

* resolve conflicts.

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

* make linter happy.

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

* address review comments.

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

---------

Signed-off-by: Tomoya Fujita <[email protected]>
Co-authored-by: David V. Lu!! <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-all backport at reviewers discretion; from rolling to all versions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants