bugGNU Octave - Bugs: bug #64067, "help properties"...


bug #64067: "help properties" returns nothing

Submitter:  Rik <rik5>
Submitted:  Tue 18 Apr 2023 10:53:58 PM UTC
Category:  Octave Function Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Incorrect Result
Status:  Fixed Assigned to:  None
Originator Name:  rik5 Open/Closed:  * Closed
Release:  * 8.2.0 Operating System:  * Any
Fixed Release:  8.3.0 Planned Release:  8.3.0
* Mandatory Fields

Add a New Comment Rich Markup

Tue 25 Apr 2023 04:49:53 PM UTC, comment #1: 

Fixed in this changeset (http://hg.savannah.gnu.org/hgweb/octave/rev/88e7edd94e2e) by removing special character \x1d from comment line which indicates start of DOCSTRING entry.

Rik <rik5>
Group administrator
Tue 18 Apr 2023 10:53:58 PM UTC, original submission:  

Example code:

help properties
'properties' is a built-in function from the file libinterp/octave-value/ov-classdef.cc

Octave knows where the function resides, but doesn't return any help text.  I tried copying the Texinfo from ov-classdef.cc into an m-file and using help on the m-file and that works.  Hence, it is not the Texinfo which is the cause of the problem.  I will note that get_help_text returns text for the "properties" keyword in classdef.

get_help_text ('properties')
ans =
@c ## @deftypefn {} {} properties
@c ## Begin a properties block in a classdef definition.
@c ## @end deftypefn

The confusion between the keyword documentation and the function documentation is probably at the root of the issue.

Rik <rik5>
Group administrator


(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:

No files currently attached


Depends on the following items: None found

Items that depend on this one: None found


Carbon-Copy List
  • -email is unavailable- added by rik5 (Submitted the item)

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only group members can vote.


    Follow 5 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2023-04-25 rik5 StatusConfirmed Fixed
        Open/ClosedOpen Closed
        Releasedev 8.2.0
        Fixed ReleaseNone 8.3.0
        Planned ReleaseNone 8.3.0

    Back to the top

    Powered by Savane 3.13-1277.
    Corresponding source code