diff options
| author | Chong Yidong | 2009-01-19 15:13:31 +0000 |
|---|---|---|
| committer | Chong Yidong | 2009-01-19 15:13:31 +0000 |
| commit | 753169bd1787fecf5c857cb3e8ffbdc92a7f104a (patch) | |
| tree | b0572d254225b8a33fdc44d04bbb049bfb906ea2 /src | |
| parent | e301e634f217af5204177bcec6437b7bab73342e (diff) | |
| download | emacs-753169bd1787fecf5c857cb3e8ffbdc92a7f104a.tar.gz emacs-753169bd1787fecf5c857cb3e8ffbdc92a7f104a.zip | |
(Fsubstring): Doc fix.
Diffstat (limited to 'src')
| -rw-r--r-- | src/fns.c | 15 |
1 files changed, 10 insertions, 5 deletions
| @@ -1183,11 +1183,16 @@ Elements of ALIST that are not conses are also shared. */) | |||
| 1183 | } | 1183 | } |
| 1184 | 1184 | ||
| 1185 | DEFUN ("substring", Fsubstring, Ssubstring, 2, 3, 0, | 1185 | DEFUN ("substring", Fsubstring, Ssubstring, 2, 3, 0, |
| 1186 | doc: /* Return a substring of STRING, starting at index FROM and ending before TO. | 1186 | doc: /* Return a new string whose contents are a substring of STRING. |
| 1187 | TO may be nil or omitted; then the substring runs to the end of STRING. | 1187 | The returned string consists of the characters between index FROM |
| 1188 | FROM and TO start at 0. If either is negative, it counts from the end. | 1188 | \(inclusive) and index TO (exclusive) of STRING. FROM and TO are |
| 1189 | 1189 | zero-indexed: 0 means the first character of STRING. Negative values | |
| 1190 | This function allows vectors as well as strings. */) | 1190 | are counted from the end of STRING. If TO is nil, the substring runs |
| 1191 | to the end of STRING. | ||
| 1192 | |||
| 1193 | The STRING argument may also be a vector. In that case, the return | ||
| 1194 | value is a new vector that contains the elements between index FROM | ||
| 1195 | \(inclusive) and index TO (exclusive) of that vector argument. */) | ||
| 1191 | (string, from, to) | 1196 | (string, from, to) |
| 1192 | Lisp_Object string; | 1197 | Lisp_Object string; |
| 1193 | register Lisp_Object from, to; | 1198 | register Lisp_Object from, to; |