Mercurial > octave-nkf
changeset 10895:4176c5c62138
Imrove documentation string for sizemax
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Tue, 17 Aug 2010 17:31:06 -0700 |
| parents | 89f13bc14494 |
| children | f7c3364947dd |
| files | src/ChangeLog src/bitfcns.cc |
| diffstat | 2 files changed, 8 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/src/ChangeLog Mon Aug 16 17:35:48 2010 -0400 +++ b/src/ChangeLog Tue Aug 17 17:31:06 2010 -0700 @@ -4,6 +4,10 @@ 2010-08-13 Rik <octave@nomad.inbox5.com> + * bitfcns.cc (sizemax): Improve documentation string. + +2010-08-13 Rik <octave@nomad.inbox5.com> + * toplev.c (do_goto_frame_relative): Remove unused variable c. 2010-08-13 Jaroslav Hajek <highegg@gmail.com>
--- a/src/bitfcns.cc Mon Aug 16 17:35:48 2010 -0400 +++ b/src/bitfcns.cc Tue Aug 17 17:31:06 2010 -0700 @@ -670,10 +670,11 @@ DEFUN (sizemax, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} sizemax ()\n\ -Return the largest value that is allowed as the size of an array.\n\ +Return the largest value allowed for the size of an array.\n\ If Octave is compiled with 64-bit indexing, the result is of class int64,\n\ -otherwise it is of class int32. It will be a tiny bit lower than the maximum\n\ -allowable value for that type, as reported by intmax.\n\ +otherwise it is of class int32. The maximum array size is slightly\n\ +smaller than the maximum value allowable for the relevant class as reported\n\ +by @code{intmax}.\n\ @seealso{intmax}\n\ @end deftypefn") {