missing items in manual pages

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

missing items in manual pages

Michael Barton
missing items in manual pages Daniel,

I just noticed that in the really nice manual pages that show up in the options dialogs for wxgrass, the section that shows the command and its arguments is missing.  These include the sections labeled SYNOPSIS, Flags:, and Parameters:

Odd that the rest of it would show up and this piece is missing.

Michael


__________________________________________
Michael Barton, Professor of Anthropology
School of Human Evolution & Social Change    
Center for Social Dynamics & Complexity
Arizona State University

phone: 480-965-6213
fax: 480-965-7671
www: http://www.public.asu.edu/~cmbarton


_______________________________________________
grassgui mailing list
[hidden email]
http://grass.itc.it/mailman/listinfo/grassgui
Reply | Threaded
Open this post in threaded view
|

Re: missing items in manual pages

Daniel Calvelo
Hi Michael.

Indeed, those sections, which describe the options are skipped on
purpose. I borrowed the idea from QGIS. The rationale AFAICT is that,
since you already have description and options list in the other tabs,
it would be redundant.

Coming to think about it, it's true that in QGIS the idea is not to
give access to raw commands but simplified versions thereof, so it is
debatable whether the full options listing should appear in the man
page.

I can put it back, of course, but some opinions and arguments might
come in handy.

Daniel.

On 5/5/07, Michael Barton <[hidden email]> wrote:

>
>  Daniel,
>
>  I just noticed that in the really nice manual pages that show up in the
> options dialogs for wxgrass, the section that shows the command and its
> arguments is missing.  These include the sections labeled SYNOPSIS, Flags:,
> and Parameters:
>
>  Odd that the rest of it would show up and this piece is missing.
>
>  Michael
>
>
>  __________________________________________
>  Michael Barton, Professor of Anthropology
>  School of Human Evolution & Social Change
>  Center for Social Dynamics & Complexity
>  Arizona State University
>
>  phone: 480-965-6213
>  fax: 480-965-7671
>  www: http://www.public.asu.edu/~cmbarton
>
>


--
-- Daniel Calvelo Aros

_______________________________________________
grassgui mailing list
[hidden email]
http://grass.itc.it/mailman/listinfo/grassgui
Reply | Threaded
Open this post in threaded view
|

Re: missing items in manual pages

Michael Barton
Part of the GRASS "culture" is for the GUI to also help teach the command
syntax, rather than hiding it from the user. As you say, there are pros and
cons to this. But I guess I'd recommend putting it in.

Michael


On 5/5/07 1:33 AM, "Daniel Calvelo" <[hidden email]> wrote:

> Hi Michael.
>
> Indeed, those sections, which describe the options are skipped on
> purpose. I borrowed the idea from QGIS. The rationale AFAICT is that,
> since you already have description and options list in the other tabs,
> it would be redundant.
>
> Coming to think about it, it's true that in QGIS the idea is not to
> give access to raw commands but simplified versions thereof, so it is
> debatable whether the full options listing should appear in the man
> page.
>
> I can put it back, of course, but some opinions and arguments might
> come in handy.
>
> Daniel.
>
> On 5/5/07, Michael Barton <[hidden email]> wrote:
>>
>>  Daniel,
>>
>>  I just noticed that in the really nice manual pages that show up in the
>> options dialogs for wxgrass, the section that shows the command and its
>> arguments is missing.  These include the sections labeled SYNOPSIS, Flags:,
>> and Parameters:
>>
>>  Odd that the rest of it would show up and this piece is missing.
>>
>>  Michael
>>
>>
>>  __________________________________________
>>  Michael Barton, Professor of Anthropology
>>  School of Human Evolution & Social Change
>>  Center for Social Dynamics & Complexity
>>  Arizona State University
>>
>>  phone: 480-965-6213
>>  fax: 480-965-7671
>>  www: http://www.public.asu.edu/~cmbarton
>>
>>
>

__________________________________________
Michael Barton, Professor of Anthropology
School of Human Evolution & Social Change
Center for Social Dynamics & Complexity
Arizona State University

phone: 480-965-6213
fax: 480-965-7671
www: http://www.public.asu.edu/~cmbarton


_______________________________________________
grassgui mailing list
[hidden email]
http://grass.itc.it/mailman/listinfo/grassgui