Fix grammar, typos, and awkward phrasing in site docs#188
Open
elharo wants to merge 2 commits into
Open
Conversation
- custom.apt: its provides -> it provides - index.apt.vm: Toolchains Plugins -> Toolchain Plugin (singular) - index.apt.vm: discover and selects -> discovers and selects - index.apt.vm: let user copy/paste -> lets the user copy and paste - usage.apt.vm: plugin that require -> plugin that requires - jdk.apt.vm: In plugin's selection -> In the plugin configuration - jdk.apt.vm: clarify jdkHome is child of configuration element - jdk.apt.vm: add missing articles (The, the) - jdk-discovery.apt.vm: reword awkward useJdk sentence
Clarified the description of the generate JDK toolchains XML goal to improve readability.
There was a problem hiding this comment.
Pull request overview
This pull request updates the Maven Toolchains Plugin site documentation to improve grammar, fix typos, and rephrase a few sentences for clarity across the usage page and several toolchain-related docs.
Changes:
- Fixes multiple typos/grammar issues (e.g., “require” → “requires”, “its provides” → “it provides”).
- Improves phrasing/clarity in the introduction and JDK toolchain documentation.
- Rewords the
useJdksentence in JDK discovery docs (though the updated wording currently references an incorrect property name).
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/site/apt/index.apt.vm | Fixes grammar and improves phrasing in the site introduction and goals overview. |
| src/site/apt/toolchains/custom.apt | Fixes a typo in the custom toolchains documentation. |
| src/site/apt/toolchains/jdk.apt.vm | Clarifies wording around JDK toolchain provides/configuration and improves sentence flow. |
| src/site/apt/toolchains/jdk-discovery.apt.vm | Rewords a sentence about controlling whether the current JDK is used (but should reference toolchain.jdk.mode). |
| src/site/apt/usage.apt.vm | Fixes a grammar issue in the usage description. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * <<<env>>> / <<<toolchain.jdk.env>>>: the name of an environment variable that the JDK toolchain must match | ||
|
|
||
| The <<<useJdk>>> can be used to define whether the current JDK can be used if it matches the requirements. | ||
| The <<<useJdk>>> property controls whether the current JDK is used when it matches the requirements. |
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.
Various documentation fixes: