octave-maintainers
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

cloned source, help just displaying copyright text?


From: Nicholas Jankowski
Subject: cloned source, help just displaying copyright text?
Date: Wed, 12 Feb 2020 13:52:09 -0500

haven't played with the source in a little while, but did something change in the docstrings that's preventing help from rendering the full docstring? running help on any command in the source tree displays only the copyright block rather than the function help. I do see that there were changes to the copyright portion of the docstring.  Deleting the first two comment lines (all the #### ) returns the behavior to normal.

e.g.:

from \octave\scripts\general

>> help common_size
'common_size' is a function from the file C:\Programs\vcs\home\nrjank\hgcode\octave\scripts\gener
al\common_size.m


 Copyright (C) 1995-2020 The Octave Project Developers

 See the file COPYRIGHT.md in the top-level directory of this
 distribution or <https://octave.org/copyright/>.

 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/>.



Additional help for built-in functions and operators is
available in the online version of the manual.  Use the command
'doc <topic>' to search the manual index.

Help and information about Octave is also available on the WWW
at https://www.octave.org and via the address@hidden
mailing list.


After deleting lines 1 and 2:
>> help common_size
'common_size' is a function from the file C:\Programs\vcs\home\nrjank\hgcode\octave\scripts\gener
al\common_size.m

 -- [ERR, YI, ...] = common_size (XI, ...)
     Determine if all input arguments are either scalar or of common
     size.

     If true, ERR is zero, and YI is a matrix of the common size with
     all entries equal to XI if this is a scalar or XI otherwise.  If
     the inputs cannot be brought to a common size, ERR is 1, and YI is
     XI.  For example:

          [err, a, b] = common_size ([1 2; 3 4], 5)
               => err = 0
               => a = [ 1, 2; 3, 4 ]
               => b = [ 5, 5; 5, 5 ]

     This is useful for implementing functions where arguments can
     either be scalars or of common size.

     See also: size, size_equal, numel, ndims.

Additional help for built-in functions and operators is
available in the online version of the manual.  Use the command
'doc <topic>' to search the manual index.

Help and information about Octave is also available on the WWW
at https://www.octave.org and via the address@hidden
mailing list.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]