Skip to content
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

Sentence checker #4592

Draft
wants to merge 22 commits into
base: rolling
Choose a base branch
from
Draft

Sentence checker #4592

wants to merge 22 commits into from

Conversation

DLu
Copy link
Contributor

@DLu DLu commented Aug 6, 2024

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.

@DLu
Copy link
Contributor Author

DLu commented Aug 6, 2024

Very important note: I resisted the urge to call this "Edgar Jr."

https://www.youtube.com/watch?v=NW14YWw3h1E

@fujitatomoya
Copy link
Collaborator

@DLu

Unfortunately, there are lots of problems, some of which are the linter, and some of which are the content.

i just got interested in this. can you rephrase this? are you saying there are many false alarms?

@DLu
Copy link
Contributor Author

DLu commented Feb 6, 2025

Taking a look at the current results on my machine, it seems like mostly the output is true positives, with a handful of false positives mixed in. The false positives include:

  • Numbered lists
  • Day abbreviations
  • People who use punctuation in their given names. Particularly ironic, coming from me, don't you think @nuclearsandwich ?

Current error count for the whole repo: 624

@fujitatomoya
Copy link
Collaborator

@DLu sounds good, if there is anything i can help, please let me know. i will take a look at the PR.

@DLu
Copy link
Contributor Author

DLu commented Feb 6, 2025

Down to 285

@fujitatomoya
Copy link
Collaborator

ninja quick 🥷 amazing 💯

@cottsay
Copy link
Member

cottsay commented Feb 11, 2025

I haven't dug into this, but it might be good to actually parse the RST so we don't need to worry about handling the syntax. Example of where we're already parsing RST: https://github.com/ros-infrastructure/catkin_pkg/blob/master/src/catkin_pkg/changelog.py

@fujitatomoya
Copy link
Collaborator

@Mergifyio rebase

Copy link
Contributor

mergify bot commented Feb 12, 2025

rebase

☑️ Nothing to do

  • -conflict [📌 rebase requirement]
  • -closed [📌 rebase requirement]
  • queue-position = -1 [📌 rebase requirement]
  • any of:
    • #commits > 1 [📌 rebase requirement]
    • #commits-behind > 0 [📌 rebase requirement]
    • -linear-history [📌 rebase requirement]

@fujitatomoya
Copy link
Collaborator

@DLu can you rebase this against rolling?

DLu and others added 8 commits February 12, 2025 23:35
…os2#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]>
…s2#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]>
@DLu
Copy link
Contributor Author

DLu commented Feb 18, 2025

Note: This PR has been split up.

DLu and others added 3 commits February 17, 2025 22:43
* Add second dot to abbreviations
* Remove some random periods
* Escape some periods
* Convert some links
* Add formatted block
Added missing ``Output:`` before the terminal output for consistency reasons

Signed-off-by: Nikos Tziaros <[email protected]>
NickTziaros and others added 5 commits February 17, 2025 22:43
ros2#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]>
@DLu
Copy link
Contributor Author

DLu commented Feb 19, 2025

@fujitatomoya My sentence checker is now checked in here: https://github.com/DLu/sphinx_tamer

At some point, I could reintegrate it with this PR, or we can work to integrate it into a GitHub check. Which do you think makes the most sense?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants