This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-resolver.git
The following commit(s) were added to refs/heads/master by this push:
new 3bba4d2b1 Fix typos and improve clarity in using resolver docs (#1713)
3bba4d2b1 is described below
commit 3bba4d2b19f8bb5e81836436308412925b0d5752
Author: Elliotte Rusty Harold <[email protected]>
AuthorDate: Mon Dec 15 13:07:58 2025 +0000
Fix typos and improve clarity in using resolver docs (#1713)
* Fix typos and improve clarity in documentation
* Fix grammar in using-resolver-in-maven-plugins.md
Correct minor grammatical errors for clarity.
* Fix link and wording in Maven plugins documentation
Updated link format and corrected wording in documentation.
---
.../markdown/using-resolver-in-maven-plugins.md | 23 +++++++++++-----------
1 file changed, 11 insertions(+), 12 deletions(-)
diff --git a/src/site/markdown/using-resolver-in-maven-plugins.md
b/src/site/markdown/using-resolver-in-maven-plugins.md
index 689481c8b..b5dd2cc93 100644
--- a/src/site/markdown/using-resolver-in-maven-plugins.md
+++ b/src/site/markdown/using-resolver-in-maven-plugins.md
@@ -18,10 +18,9 @@ specific language governing permissions and limitations
under the License.
-->
-[Apache Maven](http://maven.apache.org/) 3.x uses Resolver (former Aether) for
repository
-tasks and Maven plugins that target Maven 3.x can do so as well. To
-start, you likely want to add the following dependencies to your plugin
-POM:
+[Apache Maven](https://maven.apache.org/) 3.x uses Resolver (formerly Aether)
for repository
+tasks, and Maven plugins that target Maven 3.x can do so as well. To
+start, add the following dependencies to the plugin POM:
```xml
<project>
@@ -53,12 +52,12 @@ POM:
</project>
```
-*Note:* At runtime, the actual version of `maven-resolver-api` being used is
-enforced by the Maven core, just like other Maven APIs. So be sure to
+*Note:* At runtime, the actual version of `maven-resolver-api` added to the
classpath is
+set by the Maven core so be sure to
compile/test your plugin against the version of `maven-resolver-api` that is
used by the minimum version of Maven that your plugin wants to support.
-Next, in your mojo source, you need to grab the repository related
+Next, in your mojo source, you need to inject the repository related
components and parameters:
```java
@@ -104,8 +103,8 @@ public class MyMojo extends AbstractMojo
}
```
-Usually, you need only `remoteProjectRepositories` or
`remotePluginRepositories`
-depending on the nature of artifacts your plugin is dealing with. The other
plugin
-parameter would be superfluous in that case. But in general, the bits
-shown above should give you all the handles that you need to work with
-Aether from within a Maven plugin.
+Usually you only need one of `remoteProjectRepositories` or
`remotePluginRepositories`,
+depending on the nature of the artifacts your plugin is dealing with. The
other plugin
+parameter is superfluous. In general, the code
+shown above should give you all the handles that you need to use the resolver
+from within a Maven plugin.
