On 10/17/2010 10:29 AM, Robert Dodier wrote:
> On 10/10/10, Dieter Kaiser<drdieterkaiser at web.de> wrote:
>
>> /*******************************************************************************
>> * File : antid.mac
>> * License : GNU General Public License (GPL)
>> *
>> * Implementation of the Maxima user functions:
>> *
>> * antid (fn, var,unk)
>> * antidiff (fn, var, unk)
>> *
>> * See the Maxima reference manual for a documentation.
>> *
>> * This file is part of Maxima -- GPL CAS based on DOE-MACSYMA
>>
>> ******************************************************************************/
> I dunno. I'm not really in favor of stuff like this:
>
> I wouldn't stick a license statement on a file unless I am the author,
> or I get the statement from the author.
>
> I'd just leave out the "See the reference manual". I don't see the point of it.
>
> I'd leave out "This file is part of Maxima" too. If you find the file in
> a Maxima CVS sandbox or tar ball, you know it's part of Maxima.
>
> I'd leave out the "File:" bit. It seems superfluous. If you see the
> file name, that's enough. The name of the file might be superfluous, too;
> I don't know for sure.
>
> In general I think it's wise to avoid uninformative boilerplate stuff.
>
> best,
>
> Robert Dodier
> _______________________________________________
> Maxima mailing list
> Maxima at math.utexas.edu
> http://www.math.u
I think the file should say it is from maxima , which version and date
if appropriate, in case
it has been taken out of context.
It should include who wrote it and when, who modified it and when,
who wrote the documentation in the file, and have a specific cross
reference to the manual if possible. e.g. manual version xyz section uvw
dated mmddyy. Unless there is some indication of the author's intent for
licensing, or an inference from DOE licensing to Bill Schelter under GPL,
I would strike mention of GPL.
I never use GPL but use the more liberal BSD if i write something
that seems to "require" a license.
The line "for a documentation" is not idiomatic English.
simply "for documentation"
I would say
The commands antid ,, ..., are documented in the Maxima manual
section xxxx.yyyy of mm/dd/yy
maybe even a sourceforge link?
Generally, though, any actual information would be entirely welcome.
Boilerplate, that appears in every file, not so much.
RJF