; Improve documentation of with-restriction
* lisp/subr.el (with-restriction): * doc/lispref/positions.texi (Narrowing): Make it clear that the argument is evaluated and that the result of the evaluation must not be nil.
This commit is contained in:
parent
be34e8294a
commit
419b4d4491
2 changed files with 9 additions and 9 deletions
|
@ -1169,7 +1169,8 @@ saved bounds. In that case it is equivalent to
|
||||||
|
|
||||||
@cindex labeled narrowing
|
@cindex labeled narrowing
|
||||||
@cindex labeled restriction
|
@cindex labeled restriction
|
||||||
When the optional argument @var{label}, a symbol, is present, the
|
When the optional argument @var{label}, which is evaluated to get the
|
||||||
|
label to use and must yield a non-@code{nil} value, is present, the
|
||||||
narrowing is @dfn{labeled}. A labeled narrowing differs from a
|
narrowing is @dfn{labeled}. A labeled narrowing differs from a
|
||||||
non-labeled one in several ways:
|
non-labeled one in several ways:
|
||||||
|
|
||||||
|
|
15
lisp/subr.el
15
lisp/subr.el
|
@ -3964,11 +3964,11 @@ See also `locate-user-emacs-file'.")
|
||||||
|
|
||||||
The current restrictions, if any, are restored upon return.
|
The current restrictions, if any, are restored upon return.
|
||||||
|
|
||||||
When the optional :label LABEL argument is present, in which
|
When the optional LABEL argument, which is evaluated to get the
|
||||||
LABEL is a symbol, inside BODY, `narrow-to-region' and `widen'
|
label to use and must yield a non-nil value, is present, inside
|
||||||
can be used only within the START and END limits. To gain access
|
BODY, `narrow-to-region' and `widen' can be used only within the
|
||||||
to other portions of the buffer, use `without-restriction' with the
|
START and END limits. To gain access to other portions of the
|
||||||
same LABEL argument.
|
buffer, use `without-restriction' with the same LABEL argument.
|
||||||
|
|
||||||
\(fn START END [:label LABEL] BODY)"
|
\(fn START END [:label LABEL] BODY)"
|
||||||
(declare (indent 2) (debug t))
|
(declare (indent 2) (debug t))
|
||||||
|
@ -3990,9 +3990,8 @@ same LABEL argument.
|
||||||
|
|
||||||
The current restrictions, if any, are restored upon return.
|
The current restrictions, if any, are restored upon return.
|
||||||
|
|
||||||
When the optional :label LABEL argument is present, the
|
When the optional LABEL argument is present, the restrictions set
|
||||||
restrictions set by `with-restriction' with the same LABEL argument
|
by `with-restriction' with the same LABEL argument are lifted.
|
||||||
are lifted.
|
|
||||||
|
|
||||||
\(fn [:label LABEL] BODY)"
|
\(fn [:label LABEL] BODY)"
|
||||||
(declare (indent 0) (debug t))
|
(declare (indent 0) (debug t))
|
||||||
|
|
Loading…
Add table
Reference in a new issue