[GRASS-dev] RE: [GRASS-user] Re: Call for documentation help
Patton, Eric
epatton at nrcan.gc.ca
Thu Nov 8 09:56:32 EST 2007
Eric:
>> If the goal is to use a uniform documentation style, we should probably figure out
>> which headings are going to be accepted. I know it's not the most pressing
>> issue, but a common style could save a lot of work in re-writes in the
>> future.
Hamish:
>Auto-generated (usually)
>========================
><H2>NAME</H2>
><H2>KEYWORDS</H2>
><H2>SYNOPSIS</H2>
>
>* = Required
>! = Suggested
>. = Optional
>
>In recommended order
>--------------------
>
>* <H2>DESCRIPTION</H2>
>! <H2>NOTE</H2>, <H2>NOTES</H2>
>! <H2>EXAMPLE</H2>, <H2>EXAMPLES</H2>
>. <H2>TODO</H2>
>. <H2>BUGS</H2>
>. <H2>REFERENCE</H2>, <H2>REFERENCES</H2>
>* <H2>SEE ALSO</H2>
>* <H2>AUTHOR</H2>, <H2>AUTHORS</H2>
>
>more in this added to the wiki page:
>http://grass.gdf-hannover.de/wiki/Updating_GRASS_Documentation
>
>
>Hamish
Thanks for the feedback. This will form a good base to build on. The wiki page is much improved, too!
~ Eric.
More information about the grass-dev
mailing list