Re: New optics functions, was: Re: Contributing to octave-forge

[Martin Vogel]

Am 19.01.2014 07:01, schrieb Carnë Draug:

Hi Carnë

> You should be able to push csets now.

thanks, I'll give it a try.

>> One more question: The canonical place to add directories upon package
>> installation to the path is the PKG_ADD file, right? Or is there some
>> automation built into the common Makefiles?
> 
> You should not need to do this. I just took a look into your package
> and saw that you split your functions into 3 directories. I will very
> very much strongly advise you against it. Just place them all in the
> same directory. When you do this, you can also move the __foo__
> functions you have in inst/misc/ into inst/private.
> 
> If you really wish to have them into separate directories, I would
> then recommend to do it only during development, and to a bootstrap
> script that moves the files from inst/jones and inst/mueller_stokes
> down on level into inst/, and inst/misc into inst/private to do the
> release. After all, once the pkg is installed, it should not make any
> difference if the files are in the same or separate directories. But I
> don't think it's worth the trouble.

OK, that's easier for sure.

> Finally
> * your copyright notices on each file say "This file is part of
> Octave.". This will be a package in Octave Forge. You should remove
> that line and replace other instances of Octave with ""this program"

OK. I do not remember where I got the original message from, and then
just did copy-paste.

> * I also noticed that sometimes you do input check and return nothing
> if there's no input arguments. I think it's much more standard to give
> an error in incorrect usage (just call print_usage ) than to return
> nothing (is there any function in Octave that requires input and
> silently returns nothing when called with nargin == 0?)

I'll check that. Sounds like a bug.

> * Don't leave "revision history" on the files. The revision history is
> kept on the commit messages. If you want to have it present on a
> release, create a Changelog file for the release.

Ah, yes, sorry, this is leftover from a release elsewhere...

-Martin