[
https://issues.apache.org/jira/browse/GEODE-2842?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16137430#comment-16137430
]
ASF GitHub Bot commented on GEODE-2842:
---------------------------------------
GitHub user PurelyApplied opened a pull request:
https://github.com/apache/geode/pull/731
GEODE-2842: Removed redundant default annotation parameter values.
Driven by IntelliJ inspection, I have extended the reach of this ticket to
include any annotation, not only `@CliOption`.
----
Thank you for submitting a contribution to Apache Geode.
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
### For all changes:
- [x] Is there a JIRA ticket associated with this PR? Is it referenced in
the commit message?
- [x] Has your PR been rebased against the latest commit within the target
branch (typically `develop`)?
- [x] Is your initial contribution a single, squashed commit?
- [x] Does `gradlew build` run cleanly?
- [n/a] Have you written or updated unit tests to verify your changes?
- [n/a] If adding new dependencies to the code, are these dependencies
licensed in a way that is compatible for inclusion under [ASF
2.0](http://www.apache.org/legal/resolved.html#category-a)?
### Note:
Please ensure that once the PR is submitted, you check travis-ci for build
issues and
submit an update to your PR as soon as possible. If you need help, please
send an
email to [email protected].
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/PurelyApplied/geode geode-2842
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/geode/pull/731.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #731
----
commit 2f27ae65508935fcf3b4145f2412b450d65019f4
Author: Patrick Rhomberg <[email protected]>
Date: 2017-08-22T21:20:12Z
GEODE-2842: Removed redundant default annotation parameter values.
----
> Remove unnecessary @CliOption arguments
> ---------------------------------------
>
> Key: GEODE-2842
> URL: https://issues.apache.org/jira/browse/GEODE-2842
> Project: Geode
> Issue Type: Bug
> Components: gfsh
> Reporter: Jared Stewart
> Assignee: Jared Stewart
>
> The {{@CliOption}} annotation specifies default values for some of its fields
> (like {{mandatory}} and {{unspecifiedDefaultValue}}). Yet, we often
> explicitly set those fields to the default value. For example,
> {noformat} @CliOption(key = CliStrings.START_LOCATOR__MEMBER_NAME,
> mandatory = false,
> unspecifiedDefaultValue = CliMetaData.ANNOTATION_NULL_VALUE,
> help = CliStrings.START_LOCATOR__MEMBER_NAME__HELP) String
> memberName {noformat}
> could simply read
> {noformat} @CliOption(key = CliStrings.START_LOCATOR__MEMBER_NAME,
> help = CliStrings.START_LOCATOR__MEMBER_NAME__HELP) String
> memberName {noformat}
> Removing these redundant/unnecessary arguments will make the code a lot more
> readable.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
