From e639e10a63c574609df3f745c4adb538415d9b1b Mon Sep 17 00:00:00 2001 From: Martin Rudalics Date: Mon, 1 Feb 2016 19:01:34 +0100 Subject: Some corrections in Elisp manual * doc/lispref/buffers.texi (Read Only Buffers): Describe optional argument POSITION. * doc/lispref/debugging.texi (Error Debugging): `debug-on-signal' is an option. * doc/lispref/display.texi (Refresh Screen): Describe optional argument FRAME of `redraw-frame'. (Attribute Functions): Describe optional argument CHARACTER of `face-font'. (Defining Images): `image-load-path' is an option. (Beeping): `ring-bell-function' is an option. * doc/lispref/frames.texi (Size and Position): The PIXELWISE argument of `set-frame-size' is optional. (Raising and Lowering): The TERMINAL argument of `tty-top-frame' is optional. * doc/lispref/keymaps.texi (Controlling Active Maps): Fix doc of `set-transient-map'. * doc/lispref/minibuf.texi (Text from Minibuffer): `read-regexp-defaults-function' is an option. (Minibuffer Contents): `delete-minibuffer-contents' is a command. * doc/lispref/modes.texi (Mode Line Variables): `mode-line-position' and `mode-line-modes' are variables, not options. * doc/lispref/strings.texi (Creating Strings): The START argument of `substring' is optional. * doc/lispref/text.texi (Buffer Contents): Describe optional argument NO-PROPERTIES of `thing-at-point'. (User-Level Deletion): Both arguments of `delete-trailing-whitespace' are optional. (Margins): Use @key{RET} instead of @kbd{RET}. * doc/lispref/windows.texi (Display Action Functions): Write non-@code{nil} instead of non-nil. (Choosing Window Options): The WINDOW arg of `split-window-sensibly' is optional. (Choosing Window Options): Write non-@code{nil} instead of non-nil. (Window Start and End): Both args of `window-group-end' are optional. * src/buffer.c (Fbarf_if_buffer_read_only): Rename argument POS to POSITION to keep consisteny with doc-string. --- doc/lispref/buffers.texi | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'doc/lispref/buffers.texi') diff --git a/doc/lispref/buffers.texi b/doc/lispref/buffers.texi index e56d77c7b92..1f7f263fb21 100644 --- a/doc/lispref/buffers.texi +++ b/doc/lispref/buffers.texi @@ -755,10 +755,14 @@ When disabling Read Only mode, it disables View mode if View mode was enabled. @end deffn -@defun barf-if-buffer-read-only +@defun barf-if-buffer-read-only &optional position This function signals a @code{buffer-read-only} error if the current -buffer is read-only. @xref{Using Interactive}, for another way to -signal an error if the current buffer is read-only. +buffer is read-only. If the text at @var{position} (which defaults to +point) has the @code{inhibit-read-only} text property set, the error +will not be raised. + +@xref{Using Interactive}, for another way to signal an error if the +current buffer is read-only. @end defun @node Buffer List -- cgit v1.2.1