[Octave-bug-tracker] [bug #52685] redundant sentence in meansq docstring

[Dan Sebald]

Follow-up Comment #4, bug #52685 (project octave):

Updated patch attached.

As a general guideline (but not a hard rule, as it depends on the context) my
logic is that only variables that are in the function argument, e.g.,
myfunc(x), get the @var{x} treatment.  In the Octave doc, the indexing is
similar to coding style, i.e., it should be X(i).  I felt it might be really
confusing to any new user just getting accustom to Octave and not yet
understanding that X and x are different variables to have myfunc(X) and then
refer in the documentation to x(i).  For LaTeX it is slightly different in
that the @var{} translates to italic, sans-serif which is typically a vector
representation.  In that case, I tried to make the individual elements such as
x(i) or x_i to be italic, serif which is typically a scalar representation. 
Similarly, for LaTeX the mean value with bar over the top is also italic,
serif because it is a scalar.  And then there are some instances such as gls.m
and ols.m where the math and Octave both refer to matrices, in which case I
made all the matrices upper case (some without @var{} because they are not
function variables).

There is a runlength.m and a run_count.m.  I wonder why an underscore is used
in one case and not the other.

Something doesn't make sense regarding QUARTILE().  There is a discussion in
the documentation about how probabilities P are determined.  (The various
methods are likely meant to change the sampling intervals because
distributions can vary, e.g., thin tails, etc.)  The variable N shows up in
all these methods but I'm wondering where that comes from because if we are
generating P how do we know what its length is?

What is the following doing in stat.txi?

@DOCSTRING(histc)

@noindent
@code{unique} function documented at @ref{XREFunique,,unique} is often
useful for statistics.

@DOCSTRING(nchoosek)

It really looks out of place in the octave.pdf manual where it is located.

What is the T of the following from "help ols"?

               SIGMA = (Y-X*BETA)'
                 * (Y-X*BETA)
                 / (T-rank(X))


(file #42677)
    _______________________________________________________

Additional Item Attachment:

File name: octave-stats_documentation-djs2017dec19.patch Size:23 KB


    _______________________________________________________

Reply to this item at:

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

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