[forge-dev] [JBoss JIRA] Commented: (SEAMFORGE-52) NewProjectPlugin --topLevelPackage help text is misleading, looks like a default value (should probably have a default value.)

[Richard Kennard (JIRA)]

    [ https://issues.jboss.org/browse/SEAMFORGE-52?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12587029#comment-12587029 ] 

Richard Kennard commented on SEAMFORGE-52:
------------------------------------------

I think the problem is the convention is too subtle. You're saying:

1. If I use square brackets and 'e.g:' then I am giving an example
2. If I use parenthesis I am suggested a type

We just need to tighten this up a bit. I would suggest:

1. [e.g. com.example.project]
2. (of type java.lang.String)

So it would read:

topLevelPackage=The top level package for your Java source files [e.g: com.example.project] (of type java.lang.String):

If that's too verbose you could consider something rompy pompy like:

(cf. java.lang.String)


> NewProjectPlugin --topLevelPackage help text is misleading, looks like a default value (should probably have a default value.)
> ------------------------------------------------------------------------------------------------------------------------------
>
>                 Key: SEAMFORGE-52
>                 URL: https://issues.jboss.org/browse/SEAMFORGE-52
>             Project: Seam Forge
>          Issue Type: Enhancement
>          Components: Builtin Plugins
>    Affects Versions: 1.0.0.Alpha2
>            Reporter: Lincoln Baxter III
>            Priority: Minor
>
> [topLevelPackage=The top level package for your Java source files [e.g: "com.example.project"]  (java.lang.String)]:

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira