diff options
-rw-r--r-- | libguile/ChangeLog | 19 | ||||
-rw-r--r-- | libguile/backtrace.c | 2 | ||||
-rw-r--r-- | libguile/filesys.c | 6 | ||||
-rw-r--r-- | libguile/goops.c | 2 | ||||
-rw-r--r-- | libguile/macros.c | 21 | ||||
-rw-r--r-- | libguile/numbers.c | 6 | ||||
-rw-r--r-- | libguile/ports.c | 2 | ||||
-rw-r--r-- | libguile/posix.c | 8 | ||||
-rw-r--r-- | libguile/socket.c | 2 | ||||
-rw-r--r-- | libguile/strings.c | 2 |
10 files changed, 41 insertions, 29 deletions
diff --git a/libguile/ChangeLog b/libguile/ChangeLog index 738e23e86..f8f0924af 100644 --- a/libguile/ChangeLog +++ b/libguile/ChangeLog @@ -1,5 +1,24 @@ 2002-03-15 Neil Jerram <neil@ossau.uklinux.net> + Docstring fixes: + + * strings.c (scm_string_p): Change unnecessary `iff' to `if'. + + * ports.c (scm_sys_make_void_port): Use `@file'. + + * numbers.c (scm_number_p, scm_real_p): Use `otherwise' rather + than `else'. + + * macros.c (scm_makmacro): Don't say that the form replaces its + source, because it doesn't. + (scm_makmmacro): Clarify difference between this and scm_makmacro. + + * backtrace.c (scm_display_error), filesys.c (scm_umask, + scm_select, scm_basename), goops.c (scm_method_generic_function), + numbers.c (scm_integer_length), posix.c (scm_getgroups, scm_execl, + scm_setlocale, scm_flock), socket.c (scm_shutdown): Correct + spelling mistakes. + * debug.c (scm_debug_options), eval.c (scm_eval_options_interface), read.c (scm_read_options): Change incorrect @var in docstring to @code. diff --git a/libguile/backtrace.c b/libguile/backtrace.c index 01ef26bbf..568e2b9f3 100644 --- a/libguile/backtrace.c +++ b/libguile/backtrace.c @@ -259,7 +259,7 @@ SCM_DEFINE (scm_display_error, "display-error", 6, 0, 0, (SCM stack, SCM port, SCM subr, SCM message, SCM args, SCM rest), "Display an error message to the output port @var{port}.\n" "@var{stack} is the saved stack for the error, @var{subr} is\n" - "the name of the procedure in which the error occured and\n" + "the name of the procedure in which the error occurred and\n" "@var{message} is the actual error message, which may contain\n" "formatting instructions. These will format the arguments in\n" "the list @var{args} accordingly. @var{rest} is currently\n" diff --git a/libguile/filesys.c b/libguile/filesys.c index 15ea034f6..fa7e75427 100644 --- a/libguile/filesys.c +++ b/libguile/filesys.c @@ -281,7 +281,7 @@ SCM_DEFINE (scm_chmod, "chmod", 2, 0, 0, SCM_DEFINE (scm_umask, "umask", 0, 1, 0, (SCM mode), - "If @var{mode} is omitted, retuns a decimal number representing the current\n" + "If @var{mode} is omitted, returns a decimal number representing the current\n" "file creation mask. Otherwise the file creation mask is set to\n" "@var{mode} and the previous value is returned.\n\n" "E.g., @code{(umask #o022)} sets the mask to octal 22, decimal 18.") @@ -1106,7 +1106,7 @@ retrieve_select_type (SELECT_TYPE *set, SCM ports_ready, SCM list_or_vec) SCM_DEFINE (scm_select, "select", 3, 2, 0, (SCM reads, SCM writes, SCM excepts, SCM secs, SCM usecs), "This procedure has a variety of uses: waiting for the ability\n" - "to provide input, accept output, or the existance of\n" + "to provide input, accept output, or the existence of\n" "exceptional conditions on a collection of ports or file\n" "descriptors, or waiting for a timeout to occur.\n" "It also returns if interrupted by a signal.\n\n" @@ -1499,7 +1499,7 @@ SCM_DEFINE (scm_basename, "basename", 1, 1, 0, (SCM filename, SCM suffix), "Return the base name of the file name @var{filename}. The\n" "base name is the file name without any directory components.\n" - "If @var{suffix} is privided, and is equal to the end of\n" + "If @var{suffix} is provided, and is equal to the end of\n" "@var{basename}, it is removed also.") #define FUNC_NAME s_scm_basename { diff --git a/libguile/goops.c b/libguile/goops.c index 560421e58..03acdb516 100644 --- a/libguile/goops.c +++ b/libguile/goops.c @@ -913,7 +913,7 @@ SCM_DEFINE (scm_generic_function_methods, "generic-function-methods", 1, 0, 0, SCM_DEFINE (scm_method_generic_function, "method-generic-function", 1, 0, 0, (SCM obj), - "Return the generic function fot the method @var{obj}.") + "Return the generic function for the method @var{obj}.") #define FUNC_NAME s_scm_method_generic_function { SCM_VALIDATE_METHOD (1, obj); diff --git a/libguile/macros.c b/libguile/macros.c index d53e94931..590010a0e 100644 --- a/libguile/macros.c +++ b/libguile/macros.c @@ -115,9 +115,7 @@ SCM_DEFINE (scm_makmacro, "procedure->macro", 1, 0, 0, "Return a @dfn{macro} which, when a symbol defined to this value\n" "appears as the first symbol in an expression, evaluates the\n" "result of applying @var{code} to the expression and the\n" - "environment. The value returned from @var{code} which has been\n" - "passed to @code{procedure->memoizing-macro} replaces the form\n" - "passed to @var{code}. For example:\n" + "environment. For example:\n" "\n" "@lisp\n" "(define trace\n" @@ -137,17 +135,12 @@ SCM_DEFINE (scm_makmmacro, "procedure->memoizing-macro", 1, 0, 0, (SCM code), "Return a @dfn{macro} which, when a symbol defined to this value\n" "appears as the first symbol in an expression, evaluates the\n" - "result of applying @var{proc} to the expression and the\n" - "environment. The value returned from @var{proc} which has been\n" - "passed to @code{procedure->memoizing-macro} replaces the form\n" - "passed to @var{proc}. For example:\n" - "\n" - "@lisp\n" - "(define trace\n" - " (procedure->macro\n" - " (lambda (x env) `(set! ,(cadr x) (tracef ,(cadr x) ',(cadr x))))))\n\n" - "(trace @i{foo}) @equiv{} (set! @i{foo} (tracef @i{foo} '@i{foo})).\n" - "@end lisp") + "result of applying @var{code} to the expression and the\n" + "environment.\n\n" + "@code{procedure->memoizing-macro} is the same as\n" + "@code{procedure->macro}, except that the expression returned by\n" + "@var{code} replaces the original macro expression in the memoized\n" + "form of the containing code.") #define FUNC_NAME s_scm_makmmacro { SCM_VALIDATE_PROC (1,code); diff --git a/libguile/numbers.c b/libguile/numbers.c index c7eb1f16e..453dace45 100644 --- a/libguile/numbers.c +++ b/libguile/numbers.c @@ -1332,7 +1332,7 @@ static const char scm_ilentab[] = { SCM_DEFINE (scm_integer_length, "integer-length", 1, 0, 0, (SCM n), - "Return the number of bits neccessary to represent @var{n}.\n" + "Return the number of bits necessary to represent @var{n}.\n" "\n" "@lisp\n" "(integer-length #b10101010)\n" @@ -2887,7 +2887,7 @@ SCM_REGISTER_PROC (s_number_p, "number?", 1, 0, 0, scm_number_p); SCM_DEFINE (scm_number_p, "complex?", 1, 0, 0, (SCM x), "Return @code{#t} if @var{x} is a complex number, @code{#f}\n" - "else. Note that the sets of real, rational and integer\n" + "otherwise. Note that the sets of real, rational and integer\n" "values form subsets of the set of complex numbers, i. e. the\n" "predicate will also be fulfilled if @var{x} is a real,\n" "rational or integer number.") @@ -2907,7 +2907,7 @@ SCM_REGISTER_PROC (s_real_p, "real?", 1, 0, 0, scm_real_p); SCM_DEFINE (scm_real_p, "rational?", 1, 0, 0, (SCM x), "Return @code{#t} if @var{x} is a rational number, @code{#f}\n" - "else. Note that the set of integer values forms a subset of\n" + "otherwise. Note that the set of integer values forms a subset of\n" "the set of rational numbers, i. e. the predicate will also be\n" "fulfilled if @var{x} is an integer number. Real numbers\n" "will also satisfy this predicate, because of their limited\n" diff --git a/libguile/ports.c b/libguile/ports.c index 1720cae01..fe9fcc6d6 100644 --- a/libguile/ports.c +++ b/libguile/ports.c @@ -1546,7 +1546,7 @@ scm_void_port (char *mode_str) SCM_DEFINE (scm_sys_make_void_port, "%make-void-port", 1, 0, 0, (SCM mode), "Create and return a new void port. A void port acts like\n" - "/dev/null. The @var{mode} argument\n" + "@file{/dev/null}. The @var{mode} argument\n" "specifies the input/output modes for this port: see the\n" "documentation for @code{open-file} in @ref{File Ports}.") #define FUNC_NAME s_scm_sys_make_void_port diff --git a/libguile/posix.c b/libguile/posix.c index ab84e5cef..49e432dc4 100644 --- a/libguile/posix.c +++ b/libguile/posix.c @@ -219,7 +219,7 @@ SCM_DEFINE (scm_pipe, "pipe", 0, 0, 0, SCM_DEFINE (scm_getgroups, "getgroups", 0, 0, 0, (), "Return a vector of integers representing the current\n" - "supplimentary group IDs.") + "supplementary group IDs.") #define FUNC_NAME s_scm_getgroups { SCM ans; @@ -864,7 +864,7 @@ SCM_DEFINE (scm_execl, "execl", 1, 0, 1, (SCM filename, SCM args), "Executes the file named by @var{path} as a new process image.\n" "The remaining arguments are supplied to the process; from a C program\n" - "they are accessable as the @code{argv} argument to @code{main}.\n" + "they are accessible as the @code{argv} argument to @code{main}.\n" "Conventionally the first @var{arg} is the same as @var{path}.\n" "All arguments must be strings.\n\n" "If @var{arg} is missing, @var{path} is executed with a null\n" @@ -1213,7 +1213,7 @@ SCM_DEFINE (scm_setlocale, "setlocale", 1, 1, 0, "Otherwise the specified locale category is set to the string\n" "@var{locale} and the new value is returned as a\n" "system-dependent string. If @var{locale} is an empty string,\n" - "the locale will be set using envirionment variables.") + "the locale will be set using environment variables.") #define FUNC_NAME s_scm_setlocale { char *clocale; @@ -1586,7 +1586,7 @@ SCM_DEFINE (scm_flock, "flock", 2, 0, 0, "it to one of the other operations.\n" "@end table\n" "The return value is not specified. @var{file} may be an open\n" - "file descriptor or an open file descriptior port.") + "file descriptor or an open file descriptor port.") #define FUNC_NAME s_scm_flock { int coperation, fdes; diff --git a/libguile/socket.c b/libguile/socket.c index 804172e5e..86b61aca1 100644 --- a/libguile/socket.c +++ b/libguile/socket.c @@ -655,7 +655,7 @@ SCM_DEFINE (scm_setsockopt, "setsockopt", 4, 0, 0, SCM_DEFINE (scm_shutdown, "shutdown", 2, 0, 0, (SCM sock, SCM how), "Sockets can be closed simply by using @code{close-port}. The\n" - "@code{shutdown} procedure allows reception or tranmission on a\n" + "@code{shutdown} procedure allows reception or transmission on a\n" "connection to be shut down individually, according to the parameter\n" "@var{how}:\n\n" "@table @asis\n" diff --git a/libguile/strings.c b/libguile/strings.c index 8cd9815a5..4f5b48b18 100644 --- a/libguile/strings.c +++ b/libguile/strings.c @@ -58,7 +58,7 @@ SCM_DEFINE (scm_string_p, "string?", 1, 0, 0, (SCM obj), - "Return @code{#t} iff @var{obj} is a string, else @code{#f}.") + "Return @code{#t} if @var{obj} is a string, else @code{#f}.") #define FUNC_NAME s_scm_string_p { return SCM_BOOL (SCM_STRINGP (obj)); |