bugGNU Octave - Bugs: bug #51036, Missing documentation for some...

 
 

bug #51036: Missing documentation for some operators in operator index of manual

Submitter:  Ernst Reissner <ernstreissner>
Submitted:  Tue 16 May 2017 02:16:10 PM UTC
   
 
Category:  Documentation Severity:  2 - Minor
Priority:  3 - Low Item Group:  Documentation
Status:  Need Info Assigned to:  None
Originator Name:  ernst reissner Open/Closed:  * Open
Release:  * dev Operating System:  * Any
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Jump to the original submission

Tue 23 May 2017 07:03:30 PM UTC, comment #9: 

@mike: yes, splitting would be a good idea.

Ernst Reissner <ernstreissner>
Tue 16 May 2017 10:53:39 PM UTC, comment #8: 

Even better: shall I prepare a patch?

Ernst Reissner <ernstreissner>
Tue 16 May 2017 10:52:44 PM UTC, comment #7: 

@mike: I was lazy sorry.
Shall I split the bug report?

Ernst Reissner <ernstreissner>
Tue 16 May 2017 10:45:23 PM UTC, comment #6: 

I was confused that part of this bug report was about the Operator Index for the whole user manual, not just about the list of operators that can be overloaded. That is part of why I prefer to see one bug report for each very specific issue. These are two separate documentation issues IMHO.

I agree that the operator index is missing and should include references for these operators: .-, \=, *=, &=, and |=. Maybe the following elementwise-op-assignment operators as well: .+=, .-=, .=, ./=, .\=, .^=, and .**=.

Mike Miller <mtmiller>
Group Member
Tue 16 May 2017 10:30:10 PM UTC, comment #5: 

Just my opinion:
Either these are supported and documented or neither.
So, my comment #2 does not hit the point:
Mikes comment #2 does not either.

Ernst Reissner <ernstreissner>
Tue 16 May 2017 09:08:25 PM UTC, comment #4: 

I don't think Matlab has .+ or .- operators.  I added those to Octave for symmetry.

John W. Eaton <jwe>
Group administrator
Tue 16 May 2017 03:44:33 PM UTC, comment #3: 

Comment #2:
Yes Mike, but shall we copy the deficiencies of the matlab documentation?

Comment #1:
^= and so on is not missing in the table,
and i did not say that.
It is missing in the index.
Also in the index some page numbers are missing.

Ernst Reissner <ernstreissner>
Tue 16 May 2017 02:39:38 PM UTC, comment #2: 

Compare Octave's section 34.4.2 with this page from TMW:

https://www.mathworks.com/help/matlab/matlab_oop/implementing-operators-for-your-class.html

They also do not mention here that + and .+ are the same operator, that information is relevant elsewhere.

Mike Miller <mtmiller>
Group Member
Tue 16 May 2017 02:38:17 PM UTC, comment #1: 


> ^=, \=, |= as += is present


There are no object methods to overload these assignment operators, they have no place in this table.

> Also page numbers in index incomplete.


What page numbers?

The purpose of this table is to describe the methods that must be defined to overload an operator in an object definition. The equivalence of certain operators to each other is discussed elsewhere in section 8.3.

Mike Miller <mtmiller>
Group Member
Tue 16 May 2017 02:16:10 PM UTC, original submission:  

Table 34.1:

missing operations ~ equivalent with ! and ~= equivalent with !=

Also .+ and .- which are the same as + and -

Also * and .* equivalent with ^ and /^.

some of them are important as they are the operators
as can be found in matlab.

Also index is incomplete:


in index missing:

&= as += is present

.- as .+ is present


^=, \=, |= as += is present


Also page numbers in index incomplete.

Ernst Reissner <ernstreissner>

 

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

Attach Files:
   
   
Comment:
   

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 (Updated the item)
  • -email is unavailable- added by jwe (Posted a comment)
  • -email is unavailable- added by mtmiller (Posted a comment)
  • -email is unavailable- added by ernstreissner (Submitted the item)
  • -email is unavailable- added by ernstreissner
  •  

    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
    2017-05-26 rik5 SummaryMissing operators Missing documentation for some operators in operator index of manual
    2017-05-16 mtmiller Severity3 - Normal 2 - Minor
        Priority5 - Normal 3 - Low
        StatusNone Need Info
    2017-05-16 ernstreissner Carbon-Copy- Added -email is unavailable-

    Back to the top

    Powered by Savane 3.13-02a9.
    Corresponding source code