mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-06-12 06:41:13 +02:00
Code Activity

Minor parameters doc change

Browse source 
* doc/ref/api-control.texi (Parameters): Make the opening a bit less
  abrupt.
This commit is contained in:
Andy Wingo 2016-12-06 21:38:58 +01:00
parent 842ba2fe33
commit a5f3868e2f
1 changed files with 8 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

13
doc/ref/api-control.texi
View file

@ -1851,8 +1851,11 @@ Like @code{scm_with_dynamic_state}, but call @var{func} with
@cindex parameter object @cindex parameter object
@tindex Parameter @tindex Parameter
A parameter object is a procedure. Calling it with no arguments returns Parameters are Guile's facility for dynamically bound variables.
its value. Calling it with one argument sets the value.
On the most basic level, a parameter object is a procedure. Calling it
with no arguments returns its value. Calling it with one argument sets
the value.
@example @example
(define my-param (make-parameter 123)) (define my-param (make-parameter 123))
@ -1862,7 +1865,7 @@ its value. Calling it with one argument sets the value.
@end example @end example
The @code{parameterize} special form establishes new locations for The @code{parameterize} special form establishes new locations for
parameters, those new locations having effect within the dynamic scope parameters, those new locations having effect within the dynamic extent
of the @code{parameterize} body. Leaving restores the previous of the @code{parameterize} body. Leaving restores the previous
locations. Re-entering (through a saved continuation) will again use locations. Re-entering (through a saved continuation) will again use
the new locations. the new locations.
@ -1887,8 +1890,8 @@ effect of @code{parameterize} to just its dynamic execution.
Passing arguments to functions is thread-safe, but that soon becomes Passing arguments to functions is thread-safe, but that soon becomes
tedious when there's more than a few or when they need to pass down tedious when there's more than a few or when they need to pass down
through several layers of calls before reaching the point they should through several layers of calls before reaching the point they should
affect. And introducing a new setting to existing code is often easier affect. Introducing a new setting to existing code is often easier with
with a parameter object than adding arguments. a parameter object than adding arguments.
@deffn {Scheme Procedure} make-parameter init [converter] @deffn {Scheme Procedure} make-parameter init [converter]
Return a new parameter object, with initial value @var{init}. Return a new parameter object, with initial value @var{init}.