summaryrefslogtreecommitdiff
path: root/lispref/minibuf.texi
diff options
context:
space:
mode:
authorRomain Francoise <romain@orebokech.com>2005-09-30 18:30:10 +0000
committerRomain Francoise <romain@orebokech.com>2005-09-30 18:30:10 +0000
commit97c3e4cc37decbf26618ce80b215f1a6aea2a7b8 (patch)
tree52f32dad2f4f08d11fe70633f195fc2cb20dbaf2 /lispref/minibuf.texi
parent42b5e85ecd6609f0c35edb9eeb24936b431e940c (diff)
downloademacs-97c3e4cc37decbf26618ce80b215f1a6aea2a7b8.tar.gz
(High-Level Completion): Explain that the prompt
given to `read-buffer' should end with a colon and a space. Update usage examples.
Diffstat (limited to 'lispref/minibuf.texi')
-rw-r--r--lispref/minibuf.texi9
1 files changed, 7 insertions, 2 deletions
diff --git a/lispref/minibuf.texi b/lispref/minibuf.texi
index 04443c493f3..bc2342fc18e 100644
--- a/lispref/minibuf.texi
+++ b/lispref/minibuf.texi
@@ -1044,6 +1044,11 @@ return if the user exits with an empty minibuffer. If non-@code{nil},
it should be a string or a buffer. It is mentioned in the prompt, but
is not inserted in the minibuffer as initial input.
+The argument @var{prompt} should be a string ending with a colon and a
+space. If @var{default} is non-@code{nil}, the function inserts it in
+@var{prompt} before the colon to follow the convention for reading from
+the minibuffer with a default value (@pxref{Programming Tips}).
+
If @var{existing} is non-@code{nil}, then the name specified must be
that of an existing buffer. The usual commands to exit the minibuffer
do not exit if the text is not valid, and @key{RET} does completion to
@@ -1058,7 +1063,7 @@ only buffer name starting with the given input is
@samp{minibuffer.texi}, so that name is the value.
@example
-(read-buffer "Buffer name? " "foo" t)
+(read-buffer "Buffer name: " "foo" t)
@group
;; @r{After evaluation of the preceding expression,}
;; @r{the following prompt appears,}
@@ -1067,7 +1072,7 @@ only buffer name starting with the given input is
@group
---------- Buffer: Minibuffer ----------
-Buffer name? (default foo) @point{}
+Buffer name (default foo): @point{}
---------- Buffer: Minibuffer ----------
@end group