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

 
 

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

Submitted by:  Ernst Reissner <ernstreissner>
Submitted on:  Tue 16 May 2017 02:16:10 PM UTC  
 
Category: DocumentationSeverity: 2 - Minor
Priority: 3 - LowItem Group: Documentation
Status: Need InfoAssigned to: None
Originator Name: ernst reissnerOpen/Closed: Open
Release: devOperating System: Any

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

(Jump to the original submission 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>
Project Administrator
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>
Project 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>
Project Administrator
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>
Project Administrator
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 File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by rik5 (Updated the item)
  • -unavailable- added by jwe (Posted a comment)
  • -unavailable- added by mtmiller (Posted a comment)
  • -unavailable- added by ernstreissner (Submitted the item)
  • -unavailable- added by ernstreissner
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 5 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Fri 26 May 2017 12:19:46 AM UTCrik5SummaryMissing operators =>Missing documentation for some operators in operator index of manual
    Tue 16 May 2017 02:38:17 PM UTCmtmillerSeverity3 - Normal=>2 - Minor
      Priority5 - Normal=>3 - Low
      StatusNone=>Need Info
    Tue 16 May 2017 02:16:10 PM UTCernstreissnerCarbon-Copy-=>Added -unavailable-

    Back to the top


    Powered by Savane 3.1-cleanup1