manual typos
Jaroslav Hajek
highegg at gmail.com
Wed Sep 10 06:11:01 CDT 2008
On Tue, Sep 9, 2008 at 6:44 PM, John W. Eaton <jwe at bevo.che.wisc.edu> wrote:
> On 9-Sep-2008, Thomas Weber wrote:
>
> | Am Dienstag, den 09.09.2008, 09:21 +0200 schrieb Francesco Potorti`:
> | > In the 3.0.1 manual, at the "6.2.1 Creating Cell Array" page, I read:
> | >
> | > -- Loadable Function: C = num2cell (M, D)
> | > Convert to matrix M into a cell array. If D is defined the value C
> | > _____________^^
> | >
> | > is of dimension 1 in this dimension and the elements of M are
> | > placed in slices in C.
> | >
> | > to --> the
> | >
> | > moreover, I would use DIM rather than D, similarly to what is done for
> | > the shift function, and would put a comma after the word "defined".
> | >
> | >
> | > Later on:
> | > -- Loadable Function: B = mat2cell (A, R)
> | > Converts the matrix A to a cell array If A is 2-D, then it is
> | >
> | > A full stop is missing before "If".
> |
> | Changesets attached (I missed the 's' in the first convert in the first
> | try, though).
>
> I think it should be "Convert" not "Converts". The first sentence of
> a doc string should read like a command, not a description. This
> style is consistent with most of the other doc strings in Octave. So
> we should say
>
> Convert a matrix to a cell array ...
>
> instead of
>
> This function converts a matrix to a cell array ...
>
> or
>
> Converts a matrix to a cell array ...
>
> | No changelog entry, as the changes are trivial.
>
> I applied it.
>
transplanted to 3.0.x
--
RNDr. Jaroslav Hajek
computing expert
Aeronautical Research and Test Institute (VZLU)
Prague, Czech Republic
url: www.highegg.matfyz.cz
More information about the Bug-octave
mailing list