Mercurial > hg > octave-lyh
changeset 15622:7f4e7073b2e0 stable
doc: fix description of k in triu/tril (bug #37796)
* tril.cc (Ftril): Reword explanation of @var{k}
author | Jordi Gutiérrez Hermoso <jordigh@octave.org> |
---|---|
date | Fri, 23 Nov 2012 11:31:31 -0500 |
parents | 773892abfd93 |
children | 550147454137 ddc651eecf7a |
files | src/DLD-FUNCTIONS/tril.cc |
diffstat | 1 files changed, 3 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/src/DLD-FUNCTIONS/tril.cc +++ b/src/DLD-FUNCTIONS/tril.cc @@ -356,9 +356,9 @@ The default value of @var{k} is zero, so that @code{triu} and\n\ @code{tril} normally include the main diagonal as part of the result.\n\ \n\ -If the value of @var{k} is negative, additional elements above (for\n\ -@code{tril}) or below (for @code{triu}) the main diagonal are also\n\ -selected.\n\ +If the value of @var{k} is nonzero integer, the selection of elements\ +starts at an offset of @var{k} diagonals above or below the main\ +diagonal; above for positive @var{k} and below for negative @var{k}.\ \n\ The absolute value of @var{k} must not be greater than the number of\n\ sub-diagonals or super-diagonals.\n\