octave-maintainers
[Top][All Lists]
Advanced

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

Re: cloned source, help just displaying copyright text?


From: Mike Miller
Subject: Re: cloned source, help just displaying copyright text?
Date: Wed, 12 Feb 2020 11:35:43 -0800

On Wed, Feb 12, 2020 at 14:22:39 -0500, John W. Eaton wrote:
> On 2/12/20 1:52 PM, Nicholas Jankowski wrote:
> > 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.:
> 
> It works for me.  Did you start with a completely fresh build tree?
> 
> Are you trying to use an older version of Octave to get help from the
> current source .m files?  That's not expected to work.

Yeah, confirmed, and that's probably going to confuse some people, just
something to keep in mind. For example, we often tell users that they
can drop a function file into their load path in an older version of
Octave for simple bug fixes.

For full clarity, the change is that Octave 6 now allows newlines and
carriage returns before the word "Copyright" in the first comment block
in a function file. Octave 5 and older required that "Copyright" or
"Author" be the first word in the first line for the comment block to be
ignored for the purposes of finding the docstring.

Cheers,

-- 
mike

Attachment: signature.asc
Description: PGP signature


reply via email to

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