summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorChong Yidong <cyd@stupidchicken.com>2009-01-19 15:13:31 +0000
committerChong Yidong <cyd@stupidchicken.com>2009-01-19 15:13:31 +0000
commit753169bd1787fecf5c857cb3e8ffbdc92a7f104a (patch)
treeb0572d254225b8a33fdc44d04bbb049bfb906ea2 /src
parente301e634f217af5204177bcec6437b7bab73342e (diff)
downloademacs-753169bd1787fecf5c857cb3e8ffbdc92a7f104a.tar.gz
(Fsubstring): Doc fix.
Diffstat (limited to 'src')
-rw-r--r--src/fns.c15
1 files changed, 10 insertions, 5 deletions
diff --git a/src/fns.c b/src/fns.c
index bd3267d4ab0..913705fcf80 100644
--- a/src/fns.c
+++ b/src/fns.c
@@ -1183,11 +1183,16 @@ Elements of ALIST that are not conses are also shared. */)
}
DEFUN ("substring", Fsubstring, Ssubstring, 2, 3, 0,
- doc: /* Return a substring of STRING, starting at index FROM and ending before TO.
-TO may be nil or omitted; then the substring runs to the end of STRING.
-FROM and TO start at 0. If either is negative, it counts from the end.
-
-This function allows vectors as well as strings. */)
+ doc: /* Return a new string whose contents are a substring of STRING.
+The returned string consists of the characters between index FROM
+\(inclusive) and index TO (exclusive) of STRING. FROM and TO are
+zero-indexed: 0 means the first character of STRING. Negative values
+are counted from the end of STRING. If TO is nil, the substring runs
+to the end of STRING.
+
+The STRING argument may also be a vector. In that case, the return
+value is a new vector that contains the elements between index FROM
+\(inclusive) and index TO (exclusive) of that vector argument. */)
(string, from, to)
Lisp_Object string;
register Lisp_Object from, to;