[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Octave-bug-tracker] [bug #65259] Don't say documentation for class itse
From: |
Rik |
Subject: |
[Octave-bug-tracker] [bug #65259] Don't say documentation for class itself comes from class constructor |
Date: |
Mon, 5 Feb 2024 18:03:48 -0500 (EST) |
URL:
<https://savannah.gnu.org/bugs/?65259>
Summary: Don't say documentation for class itself comes from
class constructor
Group: GNU Octave
Submitter: rik5
Submitted: Mon 05 Feb 2024 03:03:48 PM PST
Category: Classdef
Severity: 2 - Minor
Priority: 5 - Normal
Item Group: Feature Request
Status: Confirmed
Assigned to: None
Originator Name:
Originator Email:
Open/Closed: Open
Release: dev
Discussion Lock: Any
Operating System: Any
Fixed Release: None
Planned Release: None
_______________________________________________________
Follow-up Comments:
-------------------------------------------------------
Date: Mon 05 Feb 2024 03:03:48 PM PST By: Rik <rik5>
This is a very small thing. When asking for help on a class, Octave reports
the help as coming from the "class constructor". This is not necessarily
true. Documentation is allowed both for the class and for the constructor and
they are not necessarily the same. Here is an example with inputParser:
help inputParser
'inputParser' is a class constructor from the file
/home/XXX/.../scripts/miscellaneous/inputParser.m
It would be nicer if it reported
help inputParser
'inputParser' is a class from the file
/home/XXX/.../scripts/miscellaneous/inputParser.m
for the class and the original message only for the actual constructor
accessed with "help inputParser.inputParser".
_______________________________________________________
Reply to this item at:
<https://savannah.gnu.org/bugs/?65259>
_______________________________________________
Message sent via Savannah
https://savannah.gnu.org/
- [Octave-bug-tracker] [bug #65259] Don't say documentation for class itself comes from class constructor,
Rik <=
- [Octave-bug-tracker] [bug #65259] Don't say documentation for class itself comes from class constructor, Rik, 2024/02/05
- [Octave-bug-tracker] [bug #65259] Don't say documentation for class itself comes from class constructor, John W. Eaton, 2024/02/05
- [Octave-bug-tracker] [bug #65259] Don't say documentation for class itself comes from class constructor, Rik, 2024/02/06
- [Octave-bug-tracker] [bug #65259] Don't say documentation for class itself comes from class constructor, Rik, 2024/02/06
- [Octave-bug-tracker] [bug #65259] Don't say documentation for class itself comes from class constructor, Nicholas Jankowski, 2024/02/06