[Gretl-devel] Genr functions documentation

[Sven Schreiber]

Am 15.12.2007 20:43, Riccardo (Jack) Lucchetti schrieb:
> On Sat, 15 Dec 2007, Riccardo (Jack) Lucchetti wrote:
>
>> 2) the "BFGSmax" function is undocumented in the "genr" command 
>> section, although it receives fairly extensive treatment in the 
>> User's Guide. However, documenting "genr" like any other command is 
>> maybe a bit difficult nowadays. Maybe we should add a chapter in the 
>> User's Guide documenting all the genr functions in alphabetical 
>> order. Note that this could be a collaborative effort: the User's 
>> guide is in LaTeX, so it's easy to edit for everybody, and the full 
>> list of genr functions can be easily retrieved from the source. 
>> Opinions?
>
> Ok, attached you'll find an example of what I have in mind. It's a 
> self-contained LaTeX file, so anyone can edit it. Basically, all genr 
> functions are listed one by one in strict alphabetical order. The 
> visual formatting isn't beautiful, but should give the reader the 
> ability to locate functions quickly. I wrote a few entries just to 
> give you the idea.
>
> This is something that anyone with a decent knowledge of gretl can 
> contribute to, cause it's easy but time consuming. If you write even 
> one entry, that'd be helpful. Just send the LaTeX file to me and I'll 
> merge stuff people send me into the main document. When this is 
> finished, it'll be easy to dump it into the manual proper.
>

Thanks for the effort Jack, I think it's a very good sign when a project 
cares about the documentation, so I'll try to help with this. However, 
could you maybe explain a bit more the "easily retrieved from the 
source" part? In which file exactly do they reside?

And I would suggest that people write to this list when they plan to 
document a certain function to avoid duplicate work.

thanks,
sven