|
From: | Rik |
Subject: | Re: Further suggestions for Copyright Notices |
Date: | Tue, 7 Jan 2020 12:16:13 -0800 |
On 01/07/2020 09:00 AM,
address@hidden wrote:
I agree with external code being excluded. For the manual, what are the arguments against using the same system as for the code (consistency normally being a good thing)?
If it is a one-off script needed to create the first version then it doesn't require version control. If it is a script that will need to be executed every time there is a new release then that should go somewhere in the hg archive, maybe build-aux/?
I would change the visual formatting of the Copyright block. Below is the current format as taken from wilkinson.m. ## Copyright (C) 1999-2020 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this distribution ## or <https://octave.org/COPYRIGHT.html/>. ## ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## -*- texinfo -*-d ## @deftypefn {} {} wilkinson (@var{n}) ## Return the Wilkinson matrix of order @var{n}. ## ## Wilkinson matrices are symmetric and tridiagonal with pairs of nearly, but ## not exactly, equal eigenvalues. They are useful in testing the behavior and ## performance of eigenvalue solvers. ## ## @seealso{rosser, eig} ## @end deftypefn ## Author: Peter Ekberg ## (peda) function retval = wilkinson (n) if (nargin != 1) print_usage (); endif As a programmer, I acknowledge the Copyright but I don't want to be distracted by it. I would like to be able to immediately find where the code (my interest) begins. To do that, I would set off the Copyright block in some manner from the rest of the file. A common demarcation might be a line of 80 '#' characters. If this was chosen then I would probably want that same line at the start of the file so that the entire Copyright block is surrounded. Another demarcation might be two newlines after the end of the GPL clauses. Although copyright and license are different, I don't see the need to distinguish them so strongly by having two newlines after the copyright and before the GPL clauses. I would take this back down to one newline. Also, this file happens to still have an "Author:" line. Is it still planned to remove these before the 6.1 release? --Rik |
[Prev in Thread] | Current Thread | [Next in Thread] |