Syntax in descriptions of tasks with parameters

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|

Syntax in descriptions of tasks with parameters

Jacques Le Roux
Administrator
Hi,

There was something very convenient with "Ant -p" "documentation": syntax examples.

I believe we miss that, at least found it when using "g help --task pullPluginSource". You get what it does but not how to do it (syntax).

Of course you can open the README.md file and look for reference but that's tedious and counter-intuitive.

Would you agree to add the syntax in descriptions of tasks with parameters ?

Jacques

Reply | Threaded
Open this post in threaded view
|

Re: Syntax in descriptions of tasks with parameters

taher
Why are you repeating conversations we already had?

https://s.apache.org/E1dE

On Fri, Mar 17, 2017 at 12:14 PM, Jacques Le Roux <
[hidden email]> wrote:

> Hi,
>
> There was something very convenient with "Ant -p" "documentation": syntax
> examples.
>
> I believe we miss that, at least found it when using "g help --task
> pullPluginSource". You get what it does but not how to do it (syntax).
>
> Of course you can open the README.md file and look for reference but
> that's tedious and counter-intuitive.
>
> Would you agree to add the syntax in descriptions of tasks with parameters
> ?
>
> Jacques
>
>
Reply | Threaded
Open this post in threaded view
|

Re: Syntax in descriptions of tasks with parameters

Jacques Le Roux
Administrator
Because I'm not satisfied with (eg)

------------------------------------------------------------------------------------------------------------------------------------------------------

"gradlew help --task pullPluginSource"

:help
Detailed task information for pullPluginSource
Path
      :pullPluginSource
Type
      Task (org.gradle.api.Task)
Description
      Download and install a plugin from source control
Group
      OFBiz Plugin

------------------------------------------------------------------------------------------------------------------------------------------------------

In other words, I have to look into the README file each time I don't remember the string to pass behind -P , here pluginId

So I'd like to change the description
        -task pullPluginSource(group: ofbizPlugin, description: 'Download and install a plugin from source control') {
        +task pullPluginSource(group: ofbizPlugin, description: 'Download and install a plugin from source control, parameter: pluginId') {

same for all tasks with parameters.

Agreed?

Jacques


Le 17/03/2017 à 10:43, Taher Alkhateeb a écrit :

> Why are you repeating conversations we already had?
>
> https://s.apache.org/E1dE
>
> On Fri, Mar 17, 2017 at 12:14 PM, Jacques Le Roux <
> [hidden email]> wrote:
>
>> Hi,
>>
>> There was something very convenient with "Ant -p" "documentation": syntax
>> examples.
>>
>> I believe we miss that, at least found it when using "g help --task
>> pullPluginSource". You get what it does but not how to do it (syntax).
>>
>> Of course you can open the README.md file and look for reference but
>> that's tedious and counter-intuitive.
>>
>> Would you agree to add the syntax in descriptions of tasks with parameters
>> ?
>>
>> Jacques
>>
>>

Reply | Threaded
Open this post in threaded view
|

Re: Syntax in descriptions of tasks with parameters

taher
I don't want to repeat myself, my reply is in the original thread, however,
in addition, you will note that some tasks take a lot of flags, documenting
all flags for each task would make the output of ./gradlew tasks unreadable.

So I recommend not doing that.

On Fri, Mar 17, 2017 at 1:20 PM, Jacques Le Roux <
[hidden email]> wrote:

> Because I'm not satisfied with (eg)
>
> ------------------------------------------------------------
> ------------------------------------------------------------
> ------------------------------
>
> "gradlew help --task pullPluginSource"
>
> :help
> Detailed task information for pullPluginSource
> Path
>      :pullPluginSource
> Type
>      Task (org.gradle.api.Task)
> Description
>      Download and install a plugin from source control
> Group
>      OFBiz Plugin
>
> ------------------------------------------------------------
> ------------------------------------------------------------
> ------------------------------
>
> In other words, I have to look into the README file each time I don't
> remember the string to pass behind -P , here pluginId
>
> So I'd like to change the description
>         -task pullPluginSource(group: ofbizPlugin, description: 'Download
> and install a plugin from source control') {
>         +task pullPluginSource(group: ofbizPlugin, description: 'Download
> and install a plugin from source control, parameter: pluginId') {
>
> same for all tasks with parameters.
>
> Agreed?
>
> Jacques
>
>
>
> Le 17/03/2017 à 10:43, Taher Alkhateeb a écrit :
>
>> Why are you repeating conversations we already had?
>>
>> https://s.apache.org/E1dE
>>
>> On Fri, Mar 17, 2017 at 12:14 PM, Jacques Le Roux <
>> [hidden email]> wrote:
>>
>> Hi,
>>>
>>> There was something very convenient with "Ant -p" "documentation": syntax
>>> examples.
>>>
>>> I believe we miss that, at least found it when using "g help --task
>>> pullPluginSource". You get what it does but not how to do it (syntax).
>>>
>>> Of course you can open the README.md file and look for reference but
>>> that's tedious and counter-intuitive.
>>>
>>> Would you agree to add the syntax in descriptions of tasks with
>>> parameters
>>> ?
>>>
>>> Jacques
>>>
>>>
>>>
>
Reply | Threaded
Open this post in threaded view
|

Re: Syntax in descriptions of tasks with parameters

Jacques Le Roux
Administrator
I have created https://issues.apache.org/jira/browse/OFBIZ-9274 for that and I'd appreciate other opinions than Taher's

Thanks

Jacques


Le 17/03/2017 à 11:23, Taher Alkhateeb a écrit :

> I don't want to repeat myself, my reply is in the original thread, however,
> in addition, you will note that some tasks take a lot of flags, documenting
> all flags for each task would make the output of ./gradlew tasks unreadable.
>
> So I recommend not doing that.
>
> On Fri, Mar 17, 2017 at 1:20 PM, Jacques Le Roux <
> [hidden email]> wrote:
>
>> Because I'm not satisfied with (eg)
>>
>> ------------------------------------------------------------
>> ------------------------------------------------------------
>> ------------------------------
>>
>> "gradlew help --task pullPluginSource"
>>
>> :help
>> Detailed task information for pullPluginSource
>> Path
>>       :pullPluginSource
>> Type
>>       Task (org.gradle.api.Task)
>> Description
>>       Download and install a plugin from source control
>> Group
>>       OFBiz Plugin
>>
>> ------------------------------------------------------------
>> ------------------------------------------------------------
>> ------------------------------
>>
>> In other words, I have to look into the README file each time I don't
>> remember the string to pass behind -P , here pluginId
>>
>> So I'd like to change the description
>>          -task pullPluginSource(group: ofbizPlugin, description: 'Download
>> and install a plugin from source control') {
>>          +task pullPluginSource(group: ofbizPlugin, description: 'Download
>> and install a plugin from source control, parameter: pluginId') {
>>
>> same for all tasks with parameters.
>>
>> Agreed?
>>
>> Jacques
>>
>>
>>
>> Le 17/03/2017 à 10:43, Taher Alkhateeb a écrit :
>>
>>> Why are you repeating conversations we already had?
>>>
>>> https://s.apache.org/E1dE
>>>
>>> On Fri, Mar 17, 2017 at 12:14 PM, Jacques Le Roux <
>>> [hidden email]> wrote:
>>>
>>> Hi,
>>>> There was something very convenient with "Ant -p" "documentation": syntax
>>>> examples.
>>>>
>>>> I believe we miss that, at least found it when using "g help --task
>>>> pullPluginSource". You get what it does but not how to do it (syntax).
>>>>
>>>> Of course you can open the README.md file and look for reference but
>>>> that's tedious and counter-intuitive.
>>>>
>>>> Would you agree to add the syntax in descriptions of tasks with
>>>> parameters
>>>> ?
>>>>
>>>> Jacques
>>>>
>>>>
>>>>
>