Mercurial > hg > octave-nkf
changeset 16197:576daea679fe
num2str.m: Clarify in docstring that leading spaces will be trimmed (bug #38463)
* scripts/general/num2str.m: Clarify in docstring that leading spaces will be
trimmed (bug #38463).
author | Rik <rik@octave.org> |
---|---|
date | Tue, 05 Mar 2013 14:03:36 -0800 |
parents | 5bcae3970d9d |
children | 2c5c538be353 |
files | scripts/general/num2str.m |
diffstat | 1 files changed, 12 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/general/num2str.m +++ b/scripts/general/num2str.m @@ -24,8 +24,9 @@ ## optional second argument may either give the number of significant ## digits (@var{precision}) to be used in the output or a format ## template string (@var{format}) as in @code{sprintf} (@pxref{Formatted -## Output}). @code{num2str} can also handle complex numbers. For -## example: +## Output}). @code{num2str} can also handle complex numbers. +## +## Examples: ## ## @example ## @group @@ -50,11 +51,17 @@ ## @end group ## @end example ## +## Notes: +## +## For Matlab compatibility, leading spaces are stripped before returning +## the string. +## ## The @code{num2str} function is not very flexible. For better control ## over the results, use @code{sprintf} (@pxref{Formatted Output}). -## Note that for complex @var{x}, the format string may only contain one -## output conversion specification and nothing else. Otherwise, you -## will get unpredictable results. +## +## For complex @var{x}, the format string may only contain one +## output conversion specification and nothing else. Otherwise, results +## will be unpredictable. ## @seealso{sprintf, int2str, mat2str} ## @end deftypefn