aboutsummaryrefslogtreecommitdiff
path: root/doc/language/function/cpsc-function-str_to_num.7.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/language/function/cpsc-function-str_to_num.7.md')
-rw-r--r--doc/language/function/cpsc-function-str_to_num.7.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/language/function/cpsc-function-str_to_num.7.md b/doc/language/function/cpsc-function-str_to_num.7.md
index b0ceef2..acdf60b 100644
--- a/doc/language/function/cpsc-function-str_to_num.7.md
+++ b/doc/language/function/cpsc-function-str_to_num.7.md
@@ -12,7 +12,9 @@ STR_TO_NUM(text : STRING) RETURNS REAL
# DESCRIPTION
-Return REAL, including for integer-looking text. Conversion can stop at trailing text; invalid text returns zero. Use IS_NUM first when the whole string must be a valid number.
+Provided by the standard string library, loaded and linked by default.
+
+Return REAL, including for integer-looking text. The whole string must be consumed. Invalid text, trailing junk and values outside the REAL range throw a catchable exception. Use IS_NUM first to check numeric text without throwing for invalid input.
# EXAMPLE