Improve README documentation clarity #11682
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,7 +26,7 @@ Apache Maven | |
| - [3.9.x](https://github.com/apache/maven/tree/maven-3.9.x): [](https://central.sonatype.com/artifact/org.apache.maven/apache-maven) | ||
|
|
||
|
|
||
| Apache Maven is a software project management and build automation tool. Based on | ||
|
Contributor
There was a problem hiding this comment. This changes Maven's canonical self-description. The phrase "software project management and comprehension tool" has been Maven's official tagline for over 20 years (see maven.apache.org). The word "comprehension" is intentional — it refers to Maven's ability to help developers understand a project (dependency tree, reports, site docs), not just build it. Replacing it with "build automation" narrows the meaning and diverges from the project's established identity. I would keep the original wording. |
||
| the concept of a project object model (POM), Maven can manage a project's | ||
| build, reporting and documentation from a central piece of information. | ||
|
|
||
|
|
||
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.
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.
we use such sentence in many place .... I would like to first discuss, confirm it on ML
Next we should change it globally
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.
We've discussed it before. I'd prefer not to let the perfect be the enemy of the good. Fixing one awkward, unclear doc out of 100 is better than leaving it alone while we figure out how to fix the other 99. Since we're not a mono-repo we'll never fix them all at the same time anyway.