changeset 26204:82b9b970ff19

doc: Explain what a valid variable name is in isvarname documentation. * utils.cc (Fisvarname): Explain what a valid variable name is in the documentation.
author Rik <rik@octave.org>
date Tue, 11 Dec 2018 15:10:37 -0800
parents 3c445cd7f1a4
children cf037b842a9f
files libinterp/corefcn/utils.cc
diffstat 1 files changed, 3 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/corefcn/utils.cc	Tue Dec 11 15:04:06 2018 -0800
+++ b/libinterp/corefcn/utils.cc	Tue Dec 11 15:10:37 2018 -0800
@@ -94,6 +94,9 @@
        doc: /* -*- texinfo -*-
 @deftypefn {} {} isvarname (@var{name})
 Return true if @var{name} is a valid variable name.
+
+A valid variable name is composed of letters, digits, and underscores ("_"),
+and the first character must not be a digit.
 @seealso{iskeyword, exist, who}
 @end deftypefn */)
 {