Fix grammar, typos, and awkward phrasing in site documentation#537
Open
elharo wants to merge 8 commits into
Open
Fix grammar, typos, and awkward phrasing in site documentation#537elharo wants to merge 8 commits into
elharo wants to merge 8 commits into
Conversation
- Fix subject-verb agreement: configurations goes -> go, artifacts matches -> match - Fix articles: a unclassified -> an, an library -> a library, Each tests -> Each test - Fix typos: explicitely -> explicitly, Maven3 -> Maven 3, to filters -> to filter - Fix: as follow -> as follows, the the -> the, to to if -> to if - Fix: avoid to generate -> avoid generating, Here is example -> Here is an example - Fix: added the the -> added to, as from -> since - Fix: J2EE -> Java EE / Jakarta EE
Updated wording for clarity and consistency in the documentation regarding file name mapping customization.
There was a problem hiding this comment.
Pull request overview
This PR updates the Maven EAR Plugin site documentation to correct grammar/typos and improve clarity/terminology across multiple Doxia APT/FML source files.
Changes:
- Fixes grammar/typos in multiple documentation pages (e.g., agreement, articles, common misspellings).
- Rewrites/clarifies a few explanatory passages (notably filtering/escaping guidance) for better readability.
- Updates legacy terminology (e.g., J2EE → Java EE / Jakarta EE) in several docs.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/site/fml/faq.fml | Grammar fix in FAQ question wording. |
| src/site/apt/usage.apt.vm | Fixes grammar in configuration comment and JBoss support sentence. |
| src/site/apt/tests.apt | Fixes agreement and article usage in test descriptions. |
| src/site/apt/modules.apt.vm | Fixes repeated grammar issues in module documentation. |
| src/site/apt/index.apt.vm | Updates EAR goal description terminology. |
| src/site/apt/examples/specifying-resource-ref-entries-for-the-generated-application-xml.apt.vm | Rephrases “as from” to “since” and updates Java EE naming. |
| src/site/apt/examples/specifying-env-entries-for-the-generated-application-xml.apt.vm | Rephrases “as from” to “since” and updates Java EE naming. |
| src/site/apt/examples/specifying-ejb-ref-entries-for-the-generated-application-xml.apt.vm | Rephrases “as from” to “since” and updates Java EE naming. |
| src/site/apt/examples/skinny-wars.apt.vm | Replaces J2EE references with Java EE terminology. |
| src/site/apt/examples/skinny-modules.apt.vm | Fixes missing article in example introduction sentence. |
| src/site/apt/examples/filtering-advanced.apt.vm | Rewrites/clarifies escaping explanation; fixes typos/phrasing. |
| src/site/apt/examples/excluding-files-from-ear.apt.vm | Fixes “Maven3” formatting and improves wording for exclusions. |
| src/site/apt/examples/eclipse-and-maven-integration.apt.vm | Adjusts phrasing for plural agreement (but still needs a small fix). |
| src/site/apt/examples/customize-file-name-mapping.apt.vm | Simplifies phrasing and improves punctuation/clarity. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| +--------------------- | ||
|
|
||
| As you can see <<<exclusions>>> support wildcard expressions, so you can have fast and full control over all the dependencies you'd like to exclude. No newline at end of file | ||
| As you can see <<<exclusions>>> support wildcard expressions, so you can have fine-grained control over all the dependencies you'd like to exclude. No newline at end of file |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Updated comment to clarify filtering behavior.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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
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.
Fixes multiple issues across 14 site doc files:
Grammar:
Typos:
Awkward phrasing: