diff options
| author | Lars Magne Ingebrigtsen | 2011-09-19 10:25:35 +0200 |
|---|---|---|
| committer | Lars Magne Ingebrigtsen | 2011-09-19 10:25:35 +0200 |
| commit | a4824228fa89c5b1676666ff59481042cf084e5d (patch) | |
| tree | a61e9a72014df0fb3568bd4d3b73c10b7ffdeec0 /src/lread.c | |
| parent | 713df35b6d579d4fd3674376e6092b0287dcc2a1 (diff) | |
| download | emacs-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.c | 2 |
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: | |||
| 1965 | DEFUN ("read-from-string", Fread_from_string, Sread_from_string, 1, 3, 0, | 1965 | DEFUN ("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. |
| 1967 | Returns a cons: (OBJECT-READ . FINAL-STRING-INDEX). | 1967 | Returns a cons: (OBJECT-READ . FINAL-STRING-INDEX). |
| 1968 | FINAL-STRING-INDEX is an integer giving the position of the next | ||
| 1969 | remaining chararacter in STRING. | ||
| 1968 | START and END optionally delimit a substring of STRING from which to read; | 1970 | START 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) |