[Octave-bug-tracker] [bug #56629] 'inverse' is referenced in a few places, but is an undocumented alias for 'inv'

[Mike Miller]

URL:
  <https://savannah.gnu.org/bugs/?56629>

                 Summary: 'inverse' is referenced in a few places, but is an
undocumented alias for 'inv'
                 Project: GNU Octave
            Submitted by: mtmiller
            Submitted on: Sun 14 Jul 2019 12:40:58 PM PDT
                Category: Documentation
                Severity: 2 - Minor
                Priority: 5 - Normal
              Item Group: Documentation
                  Status: None
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
         Discussion Lock: Any
                 Release: 5.1.0
        Operating System: Any

    _______________________________________________________

Details:

The 'inv' function is well-known and documented. The 'inverse' name is a
simple alias for 'inv', but it is completely undocumented in the user manual.
'help inverse' shows the docstring for 'inv', but 'doc inverse' falls back to
the concept index and lands on 'pinv'.

Do we want 'doc inverse' to work, or for 'inverse' to appear in the function
index? Or do we want it to be omitted from the manual intentionally?

Aside from that question, at a minimum I think we should change 'inverse' to
'inv' in the two files expr.txi and invhilb.m.

This bug report was inspired by a question in #octave by Labu.




    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?56629>

_______________________________________________
  Message sent via Savannah
  https://savannah.gnu.org/