Re: Contributing to octave-forge

[c.]

On 19 Oct 2013, at 13:39, Martin Vogel <address@hidden> wrote:

> Am 18.10.2013 19:40, schrieb c.:
>> If you want to contribute a package the information you referred to is still 
>> relatively up to date
>> except that in addition to the subversion repository now we also have 
>> separate mercurial repositories
>> for some of the packages ...
> 
> Thanks!
> 
> I just want to reformat the documentation text according to your
> standards before submission. Any idea for an existing M-file that you
> think is an example for good documentation? Most of my functions have
> several parameter list options...
> 
> Martin

I'm not really sure what would be a great example of how to write docstrings, 
but examples of m-files with quite complex input/output options documentation
are for example "gmres.m" or "pkg.m".

  
http://www.gnu.org/software/octave/doc/interpreter/doc_002dgmres.html#doc_002dgmres
  
http://www.gnu.org/software/octave/doc/interpreter/Installing-and-Removing-Packages.html#doc_002dpkg

To improve documentation it is also usefule to add tests and demos in your 
function:

  
http://www.gnu.org/software/octave/doc/interpreter/Test-and-Demo-Functions.html#Test-and-Demo-Functions

c.