[Octave-bug-tracker] [bug #34661] Confusing: equivalent to `x.''.

[Clem]

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

                 Summary: Confusing:  equivalent to `x.''.
                 Project: GNU Octave
            Submitted by: clemwang
            Submitted on: Wed 26 Oct 2011 09:15:09 PM GMT
                Category: None
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Documentation
                  Status: None
             Assigned to: None
         Originator Name: Clem
        Originator Email: 
             Open/Closed: Open
         Discussion Lock: Any
                 Release: 3.4.0
        Operating System: Mac OS

    _______________________________________________________

Details:

Fortunately, I already know what the transpose function does, but if I didn't,
the Octave help for the transpose() function would be confusing.  You should
not use quotes to quote an expression that uses quotes   Similarly, the use of
a period as end-of-sentence indicator near a dot symbol is a bad idea:



help transpose
`transpose' is a built-in function

 -- Built-in Function:  transpose (X)
     Return the transpose of X.  This function is equivalent to `x.''.

     See also: ctranspose


I know that
   transpose(x)
is equivalent to:
   x.'

A person new to Octave and Linear Algebra could misunderstand that line to say
transpose(x) is:

`x.''.

or even:

`x.".
(double quote instead of two single quotes).





I suspect that this has ramifications to the style used in the Octave help. 
Another confusing use of quotes and periods is with help times

This function is equivalent to `x .* y'.



I think examples would be nice too.





    _______________________________________________________

Reply to this item at:

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

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