Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MDEP-669] Optimize the documentation of <outputProperty> of build-classpath-mojo #283

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

florianli
Copy link

@florianli florianli commented Jan 15, 2023

Better description of the parameter 'outputProperty'.

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Make sure there is a JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without
    pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [MDEP-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace MDEP-XXX with the appropriate JIRA issue. Best practice
    is to use the JIRA issue title in the pull request title and in the first line of the
    commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean verify to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its clean verify).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

…classpath-mojo

 Better description of the parameter 'outputProperty'.
@florianli florianli changed the title [MDEP-669] - Optimize the documentation of <outputProperty> of build-... [MDEP-669] - Optimize the documentation of <outputProperty> of build-classpath-mojo Jan 15, 2023
@@ -87,7 +87,7 @@ public class BuildClasspathMojo extends AbstractDependencyFilterMojo implements
private String prefix;

/**
* A property to set to the content of the classpath string.
* If defined, this property is set to the classpath string.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about, "If defined, the name of a property to which the classpath will be written."

@elharo elharo changed the title [MDEP-669] - Optimize the documentation of <outputProperty> of build-classpath-mojo [MDEP-669] Optimize the documentation of <outputProperty> of build-classpath-mojo Jan 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants