[Octave-bug-tracker] [bug #51932] Documentation of function eye and others

[Ernst Reissner]

URL:
  <http://savannah.gnu.org/bugs/?51932>

                 Summary: Documentation of function eye and others 
                 Project: GNU Octave
            Submitted by: ernstreissner
            Submitted on: Mon 04 Sep 2017 01:14:15 PM UTC
                Category: Documentation
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Documentation
                  Status: None
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
         Discussion Lock: Any
                 Release: dev
        Operating System: Any

    _______________________________________________________

Details:

According to matlab documentation, 
the function eye can be invoked without argument, 
which is equivalent with calling eye(1). 
The same is true for matlab, but this is not documented. 

The second gap in documentation is the values for CLASS. 
This is optional and defaults to 'double'. 
Possible values should be 
'double', 'single', logical, 'int8', 'uint8', 'int16', 'uint16', 'int32',
'uint32', 'int64', or 'uint64', 
which all works properly in octave also without being documented. 

The third and last gap is the return value. 
Currently none is specified, which is wrong. 

Changes must be done in  libinterp/corefcn/data.cc




    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?51932>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/