manual typos

Thomas Weber thomas.weber.mail at gmail.com
Thu Sep 11 02:52:54 CDT 2008


Am Dienstag, den 09.09.2008, 12:44 -0400 schrieb John W. Eaton:
> 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.  

Hmm, I actually thought there was a "Converts" somewhere later in the
file and so I adapted it to that. But it seems I'm wrong. 

Anyway, another small doc update in consistency with the above.

	Thomas

-------------- next part --------------
# HG changeset patch
# User Thomas Weber <thomas.weber.mail at gmail.com>
# Date 1221119450 -7200
# Node ID 8b637751d585a58abc6173f98a1788eb89fa4f7f
# Parent  229bd50e6e8fc52e48bcdace9c1f0d59f6b50c23
First sentence of a doc string should read like a command

diff --git a/src/DLD-FUNCTIONS/typecast.cc b/src/DLD-FUNCTIONS/typecast.cc
--- a/src/DLD-FUNCTIONS/typecast.cc
+++ b/src/DLD-FUNCTIONS/typecast.cc
@@ -131,7 +131,7 @@
 DEFUN_DLD (typecast, args, ,
   " -*- texinfo -*-\n\
 @deftypefn {Loadable Function} {} typecast (@var{x}, @var{type})\n\
-Converts from one datatype to another without changing the underlying\n\
+Convert from one datatype to another without changing the underlying\n\
 data. The argument @var{type} defines the type of the return argument\n\
 and must be one of 'uint8', 'uint16', 'uint32', 'uint64', 'int8', 'int16',\n\
 'int32', 'int64', 'single' or 'double'.\n\


More information about the Bug-octave mailing list