summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorPhilipp Stephani <phst@google.com>2016-10-02 19:58:39 +0200
committerPhilipp Stephani <phst@google.com>2016-10-03 12:10:41 +0200
commit74b4f13842f3119f98797ea76d9be42457b330e1 (patch)
tree9555b9adc6243bef2dfd34cd766433ace00ff41a /src
parent9fc81bcf74a3cf710b6a014ec3a490ad713a0775 (diff)
downloademacs-74b4f13842f3119f98797ea76d9be42457b330e1.tar.gz
Document nil args of compare-buffer-substrings
* editfns.c (Fcompare_buffer_substrings): Document behavior when the arguments are nil.
Diffstat (limited to 'src')
-rw-r--r--src/editfns.c4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/editfns.c b/src/editfns.c
index 51b87de8821..4e90dad568f 100644
--- a/src/editfns.c
+++ b/src/editfns.c
@@ -2892,6 +2892,10 @@ Return -N if first string is less after N-1 chars, +N if first string is
greater after N-1 chars, or 0 if strings match.
The first substring is in BUFFER1 from START1 to END1 and the second
is in BUFFER2 from START2 to END2.
+All arguments may be nil. If BUFFER1 or BUFFER2 is nil, the current
+buffer is used. If START1 or START2 is nil, the value of `point-min'
+in the respective buffers is used. If END1 or END2 is nil, the value
+of `point-max' in the respective buffers is used.
The value of `case-fold-search' in the current buffer
determines whether case is significant or ignored. */)
(Lisp_Object buffer1, Lisp_Object start1, Lisp_Object end1, Lisp_Object buffer2, Lisp_Object start2, Lisp_Object end2)