On 18 Apr 2011, at 23:17, L. Markowsky wrote:

> Thank you! I recently edited three files under tests/demos. The updated 
> package is attached.
> 
> Thanks,
> L.

Hi,

It's very good to have tests with your code!

Some quick comments after I had a first glance at your code:

1) as it stands, the directory 'tests' in your package will not get installed 
by the package manager, if one does

   pkg install fuzzy-logic-toolkit.tar.gz

   it will just disappear, so most users will never get a chance to notice it 
ever existed at all.
   for this reason statements like:
   "See fuzzy-logic-toolkit/tests/demos/commandline_demo.m"
   in the help text make no sense, no-one will ever be able to find that file.

2) please consider embedding tests and demos within functions as explained here:

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

   rather than shipping them as separate files. this will also cause the demos 
to be run automatically when
   generating docs and the output to appear on the octave-forge website.

3) the copyright notice should not contain the sentence

   "This file is part of Octave."
 
   Octave and Octave-forge are two separate and distinct projects, so a package 
being hosted in Octave-Forge 
   does not make it part of Octave.
   You might want to change that with "This file is part of 
fuzzy-logic-toolkit." or something similar.

4) please consider using texinfo for the help text, it will make the output 
look better on the command line 
   and it will make it look MUCH better in the octave-forge web pages. 
   you will find enough examples about writing texinfo docstings in other 
packages on octave-forge.

5) if you don't want to use texinfo, at least remove the 
   
"##------------------------------------------------------------------------------"
   from the beginning and end of each docstring, it is non-standard and looks 
very ugly when line wrapping occurs.

6) if possible, try to stick more closely to Octave coding standards, as 
described here:
    
<http://www.gnu.org/software/octave/doc/interpreter/Octave-Sources-_0028m_002dfiles_0029.html#Octave-Sources-_0028m_002dfiles_0029>
    this is not mandatory, though, as the policy about this in Octave-Forge is 
much less strict than in Octave.

thanks again for your contribution!
c.




------------------------------------------------------------------------------
Benefiting from Server Virtualization: Beyond Initial Workload 
Consolidation -- Increasing the use of server virtualization is a top
priority.Virtualization can reduce costs, simplify management, and improve 
application availability and disaster protection. Learn more about boosting 
the value of server virtualization. http://p.sf.net/sfu/vmware-sfdev2dev
_______________________________________________
Octave-dev mailing list
Octave-dev@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/octave-dev

Reply via email to