Skip to content

Commit db198e0

Browse files
committed
; Fix wording of recently-added documentation
* src/eval.c (Fset_buffer_local_toplevel_value) (Fbuffer_local_toplevel_value): * doc/lispref/variables.texi (Default Value): Fix wording of documentation.
1 parent 511e3d4 commit db198e0

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

doc/lispref/variables.texi

+7-6
Original file line numberDiff line numberDiff line change
@@ -1942,9 +1942,10 @@ the context of @var{symbol}'s let-binding.
19421942
@end defun
19431943

19441944
@cindex top-level buffer-local value
1945-
In addition, a variable's buffer-local value may be shadowed by a
1946-
let-binding. There are two further functions to get and set the
1947-
top-level buffer-local value of a variable.
1945+
A variable's buffer-local value may also be shadowed by a
1946+
let-binding. Two functions allow getting and setting the
1947+
top-level buffer-local value of a variable, i.e., the value outside of
1948+
the let-binding.
19481949

19491950
@defun buffer-local-toplevel-value symbol &optional buffer
19501951
This function returns the local value for @var{symbol} in @var{buffer},
@@ -1966,10 +1967,10 @@ function causes a local value for them to exist in @var{buffer}. If
19661967
as the buffer-local value for the variable across changes of major mode.
19671968

19681969
This is useful when you want to make a change to a buffer-local value
1969-
that will persist after the command now being executed completes, but
1970+
that will persist after the command now being executed completes,
19701971
where your code may be executed with that variable let-bound. In this
1971-
case the usual tool for setting buffer-local values, @code{setq-local},
1972-
will only change the value of the let-binding, and not the underlying
1972+
case the usual way of setting buffer-local values, using @code{setq-local},
1973+
will only change the value inside the let-binding, and not the underlying
19731974
buffer-local value. This function sets the latter.
19741975
@end defun
19751976

src/eval.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -833,7 +833,7 @@ DEFUN ("set-default-toplevel-value", Fset_default_toplevel_value,
833833
DEFUN ("buffer-local-toplevel-value",
834834
Fbuffer_local_toplevel_value,
835835
Sbuffer_local_toplevel_value, 1, 2, 0,
836-
doc: /* Return SYMBOL's toplevel local value in BUFFER.
836+
doc: /* Return SYMBOL's toplevel buffer-local value in BUFFER.
837837
"Toplevel" means outside of any let binding.
838838
BUFFER defaults to the current buffer.
839839
If SYMBOL has no local value in BUFFER, signals an error. */)
@@ -852,8 +852,8 @@ If SYMBOL has no local value in BUFFER, signals an error. */)
852852
DEFUN ("set-buffer-local-toplevel-value",
853853
Fset_buffer_local_toplevel_value,
854854
Sset_buffer_local_toplevel_value, 2, 3, 0,
855-
doc: /* Set SYMBOL's toplevel local value to VALUE in BUFFER.
856-
"Toplevel" means outside of any let binding.
855+
doc: /* Set SYMBOL's toplevel buffer-local value in BUFFER to VALUE.
856+
"Toplevel" means outside of any let-binding.
857857
BUFFER defaults to the current buffer.
858858
Makes SYMBOL buffer-local in BUFFER if it was not already. */)
859859
(Lisp_Object symbol, Lisp_Object value, Lisp_Object buffer)

0 commit comments

Comments
 (0)