# HG changeset patch
# User Rik <octave@nomad.inbox5.com>
# Date 1307228601 25200
# Node ID d326be468b13878b8c17f11365538d8a80e9abc8
# Parent  013cd94d8d7fe5fd0fb5283ac6c11436d82da5d4
doc: str2double() inputs which cannot be parsed return NaN.

* str2double.cc: Update docstring with warning about inputs which cannot be
parsed returning NaN.

diff -r 013cd94d8d7f -r d326be468b13 src/DLD-FUNCTIONS/str2double.cc
--- a/src/DLD-FUNCTIONS/str2double.cc	Sat Jun 04 07:26:45 2011 -0700
+++ b/src/DLD-FUNCTIONS/str2double.cc	Sat Jun 04 16:03:21 2011 -0700
@@ -244,8 +244,11 @@
 case each element is converted and an array of the same dimensions is\n\
 returned.\n\
 \n\
-@code{str2double} can replace @code{str2num}, and it avoids the use of\n\
-@code{eval} on unknown data.\n\
+@code{str2double} returns NaN for elements of @var{s} which cannot be\n\
+converted.\n\
+\n\
+@code{str2double} can replace @code{str2num}, and it avoids the security\n\
+risk of using @code{eval} on unknown data.\n\
 @seealso{str2num}\n\
 @end deftypefn")
 {