Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Sentence checker #4592

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

Sentence checker #4592

wants to merge 6 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?

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

Successfully merging this pull request may close these issues.

3 participants