doc: improve grammar, spelling, and punctuation #14730
Open
Conversation
This file contains 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
MANISH-K-07
reviewed
Mar 29, 2024
There was a problem hiding this comment.
@AdoraMel , Please consider items below and make changes if you feel they make sense
MANISH-K-07
reviewed
Mar 29, 2024
There was a problem hiding this comment.
@AdoraMel , you will have to squash and rebase to single commit :)
I know, I'm working on it while adding more changes you requested. GitHub just pushed it automatically :c |
AdoraMel
force-pushed
the
docs
branch
2 times, most recently
from
73c7909
to
2c6c13c
Compare
nrmancuso
requested changes
May 2, 2024
Comment on lines
90
to
94
| <p> | ||
| The developer team of checkstyle is really a lazy bunch of | ||
| people. We try to avoid work as best as we can, but most of all | ||
| The developer team of checkstyle is a really lazy bunch of | ||
| people. We try to avoid work as best as we can, but most of all | ||
| we try to avoid working on bugs that are reported by end users. | ||
| </p> |
There was a problem hiding this comment.
I will not comment on how accurate this statement is, but I feel offended by it. I am good to not see it again.
| @@ -107,7 +108,7 @@ | |||
| <br/> | |||
| <code>mvn test jacoco:restore-instrumented-classes jacoco:report@default-report</code>. | |||
| <br/> | |||
| Check results on report target/site/jacoco/index.html in project home folder. | |||
| Check the results on the report in target/site/jacoco/index.html in project home folder. | |||
There was a problem hiding this comment.
Suggested change
| Check the results on the report in target/site/jacoco/index.html in project home folder. | |
| Check the results of the report in target/site/jacoco/index.html in project home folder. |
| @@ -127,7 +128,7 @@ | |||
| </p> | |||
|
|
|||
| <p> | |||
| The last step of verification that all works fine please do testing of your | |||
| For the last step of verification, so that everything works fine, please do testing of your | |||
There was a problem hiding this comment.
Suggested change
| For the last step of verification, so that everything works fine, please do testing of your | |
| For the last step of verification, to ensure that everything works fine, please test your |
Comment on lines
+229
to
+230
| Checkstyle can print Abstract Syntax Trees for Java and Javadoc trees. You need to run the | ||
| checkstyle jar file with the <b>-J</b> argument, providing a java file. |
There was a problem hiding this comment.
Suggested change
| Checkstyle can print Abstract Syntax Trees for Java and Javadoc trees. You need to run the | |
| checkstyle jar file with the <b>-J</b> argument, providing a java file. | |
| Checkstyle can print a combined Java and Javadoc Abstract Syntax Tree. You need to run the | |
| checkstyle jar file with the <b>-J</b> argument, providing a java file. |
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.
While reading the docs for a uni project, I noticed a few grammar mistakes in the docs. I did my best to fix them. I hope this helps to make the docs more understandable.