-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
doc: improve grammar, spelling, and punctuation #14730
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@AdoraMel , Please consider items below and make changes if you feel they make sense
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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 |
73c7909
to
2c6c13c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@AdoraMel apologies, I reviewed this some time ago and failed to click "Submit review". My response is now very late. In the future, don't hesitate to ping us after a week or so with no response.
<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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will not comment on how accurate this statement is, but I feel offended by it. I am good to not see it again.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, let’s remove it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am ok to remove
@@ -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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
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.