aboutsummaryrefslogtreecommitdiffstats
path: root/src/lread.c
diff options
context:
space:
mode:
authorLars Magne Ingebrigtsen2011-09-19 10:25:35 +0200
committerLars Magne Ingebrigtsen2011-09-19 10:25:35 +0200
commita4824228fa89c5b1676666ff59481042cf084e5d (patch)
treea61e9a72014df0fb3568bd4d3b73c10b7ffdeec0 /src/lread.c
parent713df35b6d579d4fd3674376e6092b0287dcc2a1 (diff)
downloademacs-a4824228fa89c5b1676666ff59481042cf084e5d.tar.gz
emacs-a4824228fa89c5b1676666ff59481042cf084e5d.zip
* lread.c (Fread_from_string): Document what FINAL-STRING-INDEX is.
Fixes: debbugs:9493
Diffstat (limited to 'src/lread.c')
-rw-r--r--src/lread.c2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/lread.c b/src/lread.c
index 11c4cf8c8f4..2b1b49ab2fe 100644
--- a/src/lread.c
+++ b/src/lread.c
@@ -1965,6 +1965,8 @@ STREAM or the value of `standard-input' may be:
1965DEFUN ("read-from-string", Fread_from_string, Sread_from_string, 1, 3, 0, 1965DEFUN ("read-from-string", Fread_from_string, Sread_from_string, 1, 3, 0,
1966 doc: /* Read one Lisp expression which is represented as text by STRING. 1966 doc: /* Read one Lisp expression which is represented as text by STRING.
1967Returns a cons: (OBJECT-READ . FINAL-STRING-INDEX). 1967Returns a cons: (OBJECT-READ . FINAL-STRING-INDEX).
1968FINAL-STRING-INDEX is an integer giving the position of the next
1969 remaining chararacter in STRING.
1968START and END optionally delimit a substring of STRING from which to read; 1970START and END optionally delimit a substring of STRING from which to read;
1969 they default to 0 and (length STRING) respectively. */) 1971 they default to 0 and (length STRING) respectively. */)
1970 (Lisp_Object string, Lisp_Object start, Lisp_Object end) 1972 (Lisp_Object string, Lisp_Object start, Lisp_Object end)