Work on grammar, phrasing, and verbosity #1500
Conversation
Work on grammar, awkwardness, and verbosity
elharo
changed the title
|
Ping me if you are done (title with "Work on" sounds like a work in progress). |
Refine wording and improve clarity in plugin documentation.
There was a problem hiding this comment.
Pull request overview
This PR improves the grammar, phrasing, and verbosity of the Maven plugin documentation guide. The changes focus on correcting grammatical errors, improving clarity, and making the text more concise and professional.
Key changes:
- Corrected grammar and verb agreement issues throughout (e.g., "frequent complain" → "frequent complaints about", "needs" → "need")
- Improved sentence structure and reduced verbosity (e.g., "In case you still have" → "If you have", "feel like" → "think")
- Enhanced professionalism and consistency in writing style (capitalized bullet points, added proper punctuation)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| concern. Especially for fixing bugs, it is crucial that the developers can reproduce your problem. For this reason, | ||
| entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. | ||
| Of course, patches are welcome, too. Contributors can check out the project from our | ||
| Of course, patches are welcome too. Contributors can check out the project from our |
There was a problem hiding this comment.
The phrase "welcome too" should be "welcome, too" (with a comma). The comma is needed because "too" is an adverb that modifies the sentence and should be set off by a comma for clarity.
| Of course, patches are welcome too. Contributors can check out the project from our | |
| Of course, patches are welcome, too. Contributors can check out the project from our |
| already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching | ||
| If you have questions regarding the plugin, consult the {{{faq.html}FAQ}} and feel | ||
| free to contact the {{{mailing-lists.html}user mailing list}}. Posts to the mailing list are archived and might | ||
| already contain the answer to your question. Hence, it is worth browsing/searching |
There was a problem hiding this comment.
The phrase "it is worth" should be "it is also worth" to maintain the logical connection with the previous sentence. The word "also" emphasizes that browsing the mail archive is an additional action beyond just posting to the mailing list.
| already contain the answer to your question. Hence, it is worth browsing/searching | |
| already contain the answer to your question. Hence, it is also worth browsing/searching |
2 participants
Work on grammar, awkwardness, and verbosity