GitHub user Dispader opened a pull request:
https://github.com/apache/groovy/pull/274
Normalize groovysh command descriptions
A `:help` command issued from the Groovy Shell offers command descriptions.
The majority of commands match the same style, beginning with imperative verbs
and not ending with punctuation.
I think that the description field is not only an extremely helpful
feature, but makes the shell look like a very professional and polished product.
This commit attempts to change the style of all descriptions to match the
style in the majority.
Hope this finds you all well, and hope it helps!
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/Dispader/groovy
normalize_groovysh_command_descriptions
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/groovy/pull/274.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 #274
----
commit 2f89de4a458600061847b473d8d030d54e83facb
Author: Jake Gage <[email protected]>
Date: 2016-02-29T06:02:48Z
Remove ending puncutation from :clear command
The ClearCommand (:clear) is the only command whose description (shown
during `:help`) ends with a period. This commit makes its description
match the style of other commands.
commit 5f38e146836361299052c54b7a12595eccb5e2b7
Author: Jake Gage <[email protected]>
Date: 2016-02-29T06:07:54Z
Make verb case for command descriptions match
The majority of commands use the imperitive voice (e.g.: 'Set',
'Exit'). This commit makes the DocCommand and RegisterCommand
match this style.
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
