Mercurial > hg > octave-lyh
diff src/bitfcns.cc @ 13922:6da23a2d7afc
doc: Update bitshift() docstring
* bitfcns.cc (bitshift): Update docstring.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 22 Nov 2011 21:05:20 -0800 |
parents | f96b9b9f141b |
children | 72c96de7a403 |
line wrap: on
line diff
--- a/src/bitfcns.cc +++ b/src/bitfcns.cc @@ -410,10 +410,10 @@ @deftypefn {Built-in Function} {} bitshift (@var{a}, @var{k})\n\ @deftypefnx {Built-in Function} {} bitshift (@var{a}, @var{k}, @var{n})\n\ Return a @var{k} bit shift of @var{n}-digit unsigned\n\ -integers in @var{a}. A positive @var{k} leads to a left shift.\n\ +integers in @var{a}. A positive @var{k} leads to a left shift;\n\ A negative value to a right shift. If @var{n} is omitted it defaults\n\ to log2(bitmax)+1.\n\ -@var{n} must be in the range [1,log2(bitmax)+1] usually [1,33]\n\ +@var{n} must be in the range [1,log2(bitmax)+1] usually [1,33].\n\ \n\ @example\n\ @group\n\