summaryrefslogtreecommitdiff
path: root/libguile/promises.c
diff options
context:
space:
mode:
authorBake Timmons <b3timmons@speedymail.org>2012-01-11 23:33:01 -0500
committerAndy Wingo <wingo@pobox.com>2012-02-02 12:22:10 +0100
commitb7e64f8b266651e5b3fae6f664a45468f0c4907f (patch)
tree968302e8ca0b4b4976802426f586b68982ffb01a /libguile/promises.c
parentc99acbf3978220873235c17a79fb37ef0933f3c6 (diff)
downloadguile-b7e64f8b266651e5b3fae6f664a45468f0c4907f.tar.gz
Improve the usage of variable names in C docstrings.
* libguile/alist.c: * libguile/array-map.c: * libguile/arrays.c: * libguile/bitvectors.c: * libguile/filesys.c: * libguile/foreign.c: * libguile/generalized-arrays.c: * libguile/hashtab.c: * libguile/ioext.c: * libguile/load.c: * libguile/numbers.c: * libguile/ports.c: * libguile/posix.c: * libguile/print.c: * libguile/procprop.c: * libguile/promises.c: * libguile/simpos.c: * libguile/socket.c: * libguile/srfi-1.c: * libguile/srfi-13.c: * libguile/srfi-14.c: * libguile/stacks.c: * libguile/stime.c: * libguile/strings.c: * libguile/struct.c: * libguile/symbols.c: * libguile/threads.c: * libguile/weak-table.c: * libguile/weak-vector.c: Make the variable names in the C docstrings more consistent. Replace a few instances of @var with @code when appropriate.
Diffstat (limited to 'libguile/promises.c')
-rw-r--r--libguile/promises.c4
1 files changed, 2 insertions, 2 deletions
diff --git a/libguile/promises.c b/libguile/promises.c
index 4aff15092..3bbb489d2 100644
--- a/libguile/promises.c
+++ b/libguile/promises.c
@@ -98,8 +98,8 @@ promise_print (SCM exp, SCM port, scm_print_state *pstate)
SCM_DEFINE (scm_force, "force", 1, 0, 0,
(SCM promise),
- "If the promise @var{x} has not been computed yet, compute and\n"
- "return @var{x}, otherwise just return the previously computed\n"
+ "If @var{promise} has not been computed yet, compute and\n"
+ "return @var{promise}, otherwise just return the previously computed\n"
"value.")
#define FUNC_NAME s_scm_force
{