-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
base: rolling
Are you sure you want to change the base?
Sentence checker #4592
Conversation
Very important note: I resisted the urge to call this "Edgar Jr." |
i just got interested in this. can you rephrase this? are you saying there are many false alarms? |
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:
Current error count for the whole repo: 624 |
@DLu sounds good, if there is anything i can help, please let me know. i will take a look at the PR. |
Down to 285 |
ninja quick 🥷 amazing 💯 |
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 |
@Mergifyio rebase |
☑️ Nothing to do
|
@DLu can you rebase this against rolling? |
Signed-off-by: Tomoya Fujita <[email protected]>
…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]>
Note: This PR has been split up.
|
* Add second dot to abbreviations * Remove some random periods * Escape some periods * Convert some links * Add formatted block
Signed-off-by: Tomoya Fujita <[email protected]>
Added missing ``Output:`` before the terminal output for consistency reasons Signed-off-by: Nikos Tziaros <[email protected]>
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]>
@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? |
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.