mirror of
https://git.savannah.gnu.org/git/guile.git
synced 2025-06-17 09:10:22 +02:00
fix typos in the manual bits generated from source comments.
* libguile/bitvectors.c, libguile/chars.c, libguile/deprecated.c, libguile/numbers.c, libguile/random.c, libguile/read.c, libguile/root.c, libguile/srfi-1.c, libguile/srfi-13.c, libguile/srfi-14.c, libguile/uniform.c: Fix typos, add missing newlines.
This commit is contained in:
parent
ecb8733562
commit
ffb62a43dc
11 changed files with 27 additions and 27 deletions
|
@ -496,7 +496,7 @@ find_first_one (scm_t_uint32 x)
|
||||||
|
|
||||||
SCM_DEFINE (scm_bit_position, "bit-position", 3, 0, 0,
|
SCM_DEFINE (scm_bit_position, "bit-position", 3, 0, 0,
|
||||||
(SCM item, SCM v, SCM k),
|
(SCM item, SCM v, SCM k),
|
||||||
"Return the index of the first occurrance of @var{item} in bit\n"
|
"Return the index of the first occurrence of @var{item} in bit\n"
|
||||||
"vector @var{v}, starting from @var{k}. If there is no\n"
|
"vector @var{v}, starting from @var{k}. If there is no\n"
|
||||||
"@var{item} entry between @var{k} and the end of\n"
|
"@var{item} entry between @var{k} and the end of\n"
|
||||||
"@var{bitvector}, then return @code{#f}. For example,\n"
|
"@var{bitvector}, then return @code{#f}. For example,\n"
|
||||||
|
|
|
@ -265,7 +265,7 @@ SCM scm_char_ci_less_p (SCM x, SCM y)
|
||||||
static SCM scm_i_char_ci_leq_p (SCM x, SCM y, SCM rest);
|
static SCM scm_i_char_ci_leq_p (SCM x, SCM y, SCM rest);
|
||||||
SCM_DEFINE (scm_i_char_ci_leq_p, "char-ci<=?", 0, 2, 1,
|
SCM_DEFINE (scm_i_char_ci_leq_p, "char-ci<=?", 0, 2, 1,
|
||||||
(SCM x, SCM y, SCM rest),
|
(SCM x, SCM y, SCM rest),
|
||||||
"Return @code{#t} iff the case-folded Unicodd code point of @var{x} is\n"
|
"Return @code{#t} iff the case-folded Unicode code point of @var{x} is\n"
|
||||||
"less than or equal to the case-folded code point of @var{y}, else\n"
|
"less than or equal to the case-folded code point of @var{y}, else\n"
|
||||||
"@code{#f}")
|
"@code{#f}")
|
||||||
#define FUNC_NAME s_scm_i_char_ci_leq_p
|
#define FUNC_NAME s_scm_i_char_ci_leq_p
|
||||||
|
|
|
@ -1341,7 +1341,7 @@ SCM_DEFINE (scm_uniform_vector_read_x, "uniform-vector-read!", 1, 3, 0,
|
||||||
"leaving the remainder of the vector unchanged.\n\n"
|
"leaving the remainder of the vector unchanged.\n\n"
|
||||||
"When @var{port-or-fdes} is a port, all specified elements\n"
|
"When @var{port-or-fdes} is a port, all specified elements\n"
|
||||||
"of @var{uvec} are attempted to be read, potentially blocking\n"
|
"of @var{uvec} are attempted to be read, potentially blocking\n"
|
||||||
"while waiting formore input or end-of-file.\n"
|
"while waiting for more input or end-of-file.\n"
|
||||||
"When @var{port-or-fd} is an integer, a single call to\n"
|
"When @var{port-or-fd} is an integer, a single call to\n"
|
||||||
"read(2) is made.\n\n"
|
"read(2) is made.\n\n"
|
||||||
"An error is signalled when the last element has only\n"
|
"An error is signalled when the last element has only\n"
|
||||||
|
|
|
@ -7954,7 +7954,7 @@ SCM_PRIMITIVE_GENERIC (scm_exp, "exp", 1, 0, 0,
|
||||||
SCM_PRIMITIVE_GENERIC (scm_sqrt, "sqrt", 1, 0, 0,
|
SCM_PRIMITIVE_GENERIC (scm_sqrt, "sqrt", 1, 0, 0,
|
||||||
(SCM z),
|
(SCM z),
|
||||||
"Return the square root of @var{z}. Of the two possible roots\n"
|
"Return the square root of @var{z}. Of the two possible roots\n"
|
||||||
"(positive and negative), the one with the a positive real part\n"
|
"(positive and negative), the one with positive real part\n"
|
||||||
"is returned, or if that's zero then a positive imaginary part.\n"
|
"is returned, or if that's zero then a positive imaginary part.\n"
|
||||||
"Thus,\n"
|
"Thus,\n"
|
||||||
"\n"
|
"\n"
|
||||||
|
|
|
@ -447,7 +447,7 @@ SCM_DEFINE (scm_seed_to_random_state, "seed->random-state", 1, 0, 0,
|
||||||
SCM_DEFINE (scm_datum_to_random_state, "datum->random-state", 1, 0, 0,
|
SCM_DEFINE (scm_datum_to_random_state, "datum->random-state", 1, 0, 0,
|
||||||
(SCM datum),
|
(SCM datum),
|
||||||
"Return a new random state using @var{datum}, which should have\n"
|
"Return a new random state using @var{datum}, which should have\n"
|
||||||
"been obtailed from @code{random-state->datum}.")
|
"been obtained from @code{random-state->datum}.")
|
||||||
#define FUNC_NAME s_scm_datum_to_random_state
|
#define FUNC_NAME s_scm_datum_to_random_state
|
||||||
{
|
{
|
||||||
return make_rstate (scm_c_rstate_from_datum (datum));
|
return make_rstate (scm_c_rstate_from_datum (datum));
|
||||||
|
|
|
@ -1750,7 +1750,7 @@ scm_i_scan_for_encoding (SCM port)
|
||||||
SCM_DEFINE (scm_file_encoding, "file-encoding", 1, 0, 0,
|
SCM_DEFINE (scm_file_encoding, "file-encoding", 1, 0, 0,
|
||||||
(SCM port),
|
(SCM port),
|
||||||
"Scans the port for an Emacs-like character coding declaration\n"
|
"Scans the port for an Emacs-like character coding declaration\n"
|
||||||
"near the top of the contents of a port with random-acessible contents.\n"
|
"near the top of the contents of a port with random-accessible contents.\n"
|
||||||
"The coding declaration is of the form\n"
|
"The coding declaration is of the form\n"
|
||||||
"@code{coding: XXXXX} and must appear in a scheme comment.\n"
|
"@code{coding: XXXXX} and must appear in a scheme comment.\n"
|
||||||
"\n"
|
"\n"
|
||||||
|
|
|
@ -155,9 +155,9 @@ cwdr (SCM proc, SCM a1, SCM args, SCM handler, SCM_STACKITEM *stack_start)
|
||||||
|
|
||||||
SCM_DEFINE (scm_call_with_dynamic_root, "call-with-dynamic-root", 2, 0, 0,
|
SCM_DEFINE (scm_call_with_dynamic_root, "call-with-dynamic-root", 2, 0, 0,
|
||||||
(SCM thunk, SCM handler),
|
(SCM thunk, SCM handler),
|
||||||
"Call @var{thunk} with a new dynamic state and within"
|
"Call @var{thunk} with a new dynamic state and within\n"
|
||||||
"a continuation barrier. The @var{handler} catches all"
|
"a continuation barrier. The @var{handler} catches all\n"
|
||||||
"otherwise uncaught throws and executes within the same"
|
"otherwise uncaught throws and executes within the same\n"
|
||||||
"dynamic context as @var{thunk}.")
|
"dynamic context as @var{thunk}.")
|
||||||
#define FUNC_NAME s_scm_call_with_dynamic_root
|
#define FUNC_NAME s_scm_call_with_dynamic_root
|
||||||
{
|
{
|
||||||
|
|
|
@ -1026,7 +1026,7 @@ SCM_DEFINE (scm_srfi1_assoc, "assoc", 2, 1, 0,
|
||||||
SCM_DEFINE (scm_srfi1_partition, "partition", 2, 0, 0,
|
SCM_DEFINE (scm_srfi1_partition, "partition", 2, 0, 0,
|
||||||
(SCM pred, SCM list),
|
(SCM pred, SCM list),
|
||||||
"Partition the elements of @var{list} with predicate @var{pred}.\n"
|
"Partition the elements of @var{list} with predicate @var{pred}.\n"
|
||||||
"Return two values: the list of elements satifying @var{pred} and\n"
|
"Return two values: the list of elements satisfying @var{pred} and\n"
|
||||||
"the list of elements @emph{not} satisfying @var{pred}. The order\n"
|
"the list of elements @emph{not} satisfying @var{pred}. The order\n"
|
||||||
"of the output lists follows the order of @var{list}. @var{list}\n"
|
"of the output lists follows the order of @var{list}. @var{list}\n"
|
||||||
"is not mutated. One of the output lists may share memory with @var{list}.\n")
|
"is not mutated. One of the output lists may share memory with @var{list}.\n")
|
||||||
|
@ -1185,7 +1185,7 @@ SCM_DEFINE (scm_srfi1_remove_x, "remove!", 2, 0, 0,
|
||||||
|
|
||||||
SCM_DEFINE (scm_srfi1_take_right, "take-right", 2, 0, 0,
|
SCM_DEFINE (scm_srfi1_take_right, "take-right", 2, 0, 0,
|
||||||
(SCM lst, SCM n),
|
(SCM lst, SCM n),
|
||||||
"Return the a list containing the @var{n} last elements of\n"
|
"Return a list containing the @var{n} last elements of\n"
|
||||||
"@var{lst}.")
|
"@var{lst}.")
|
||||||
#define FUNC_NAME s_scm_srfi1_take_right
|
#define FUNC_NAME s_scm_srfi1_take_right
|
||||||
{
|
{
|
||||||
|
|
|
@ -1640,14 +1640,14 @@ SCM_DEFINE (scm_string_suffix_ci_p, "string-suffix-ci?", 2, 4, 0,
|
||||||
SCM_DEFINE (scm_string_index, "string-index", 2, 2, 0,
|
SCM_DEFINE (scm_string_index, "string-index", 2, 2, 0,
|
||||||
(SCM s, SCM char_pred, SCM start, SCM end),
|
(SCM s, SCM char_pred, SCM start, SCM end),
|
||||||
"Search through the string @var{s} from left to right, returning\n"
|
"Search through the string @var{s} from left to right, returning\n"
|
||||||
"the index of the first occurence of a character which\n"
|
"the index of the first occurrence of a character which\n"
|
||||||
"\n"
|
"\n"
|
||||||
"@itemize @bullet\n"
|
"@itemize @bullet\n"
|
||||||
"@item\n"
|
"@item\n"
|
||||||
"equals @var{char_pred}, if it is character,\n"
|
"equals @var{char_pred}, if it is character,\n"
|
||||||
"\n"
|
"\n"
|
||||||
"@item\n"
|
"@item\n"
|
||||||
"satisifies the predicate @var{char_pred}, if it is a procedure,\n"
|
"satisfies the predicate @var{char_pred}, if it is a procedure,\n"
|
||||||
"\n"
|
"\n"
|
||||||
"@item\n"
|
"@item\n"
|
||||||
"is in the set @var{char_pred}, if it is a character set.\n"
|
"is in the set @var{char_pred}, if it is a character set.\n"
|
||||||
|
@ -1705,14 +1705,14 @@ SCM_DEFINE (scm_string_index, "string-index", 2, 2, 0,
|
||||||
SCM_DEFINE (scm_string_index_right, "string-index-right", 2, 2, 0,
|
SCM_DEFINE (scm_string_index_right, "string-index-right", 2, 2, 0,
|
||||||
(SCM s, SCM char_pred, SCM start, SCM end),
|
(SCM s, SCM char_pred, SCM start, SCM end),
|
||||||
"Search through the string @var{s} from right to left, returning\n"
|
"Search through the string @var{s} from right to left, returning\n"
|
||||||
"the index of the last occurence of a character which\n"
|
"the index of the last occurrence of a character which\n"
|
||||||
"\n"
|
"\n"
|
||||||
"@itemize @bullet\n"
|
"@itemize @bullet\n"
|
||||||
"@item\n"
|
"@item\n"
|
||||||
"equals @var{char_pred}, if it is character,\n"
|
"equals @var{char_pred}, if it is character,\n"
|
||||||
"\n"
|
"\n"
|
||||||
"@item\n"
|
"@item\n"
|
||||||
"satisifies the predicate @var{char_pred}, if it is a procedure,\n"
|
"satisfies the predicate @var{char_pred}, if it is a procedure,\n"
|
||||||
"\n"
|
"\n"
|
||||||
"@item\n"
|
"@item\n"
|
||||||
"is in the set if @var{char_pred} is a character set.\n"
|
"is in the set if @var{char_pred} is a character set.\n"
|
||||||
|
@ -1770,14 +1770,14 @@ SCM_DEFINE (scm_string_index_right, "string-index-right", 2, 2, 0,
|
||||||
SCM_DEFINE (scm_string_rindex, "string-rindex", 2, 2, 0,
|
SCM_DEFINE (scm_string_rindex, "string-rindex", 2, 2, 0,
|
||||||
(SCM s, SCM char_pred, SCM start, SCM end),
|
(SCM s, SCM char_pred, SCM start, SCM end),
|
||||||
"Search through the string @var{s} from right to left, returning\n"
|
"Search through the string @var{s} from right to left, returning\n"
|
||||||
"the index of the last occurence of a character which\n"
|
"the index of the last occurrence of a character which\n"
|
||||||
"\n"
|
"\n"
|
||||||
"@itemize @bullet\n"
|
"@itemize @bullet\n"
|
||||||
"@item\n"
|
"@item\n"
|
||||||
"equals @var{char_pred}, if it is character,\n"
|
"equals @var{char_pred}, if it is character,\n"
|
||||||
"\n"
|
"\n"
|
||||||
"@item\n"
|
"@item\n"
|
||||||
"satisifies the predicate @var{char_pred}, if it is a procedure,\n"
|
"satisfies the predicate @var{char_pred}, if it is a procedure,\n"
|
||||||
"\n"
|
"\n"
|
||||||
"@item\n"
|
"@item\n"
|
||||||
"is in the set if @var{char_pred} is a character set.\n"
|
"is in the set if @var{char_pred} is a character set.\n"
|
||||||
|
@ -1792,14 +1792,14 @@ SCM_DEFINE (scm_string_rindex, "string-rindex", 2, 2, 0,
|
||||||
SCM_DEFINE (scm_string_skip, "string-skip", 2, 2, 0,
|
SCM_DEFINE (scm_string_skip, "string-skip", 2, 2, 0,
|
||||||
(SCM s, SCM char_pred, SCM start, SCM end),
|
(SCM s, SCM char_pred, SCM start, SCM end),
|
||||||
"Search through the string @var{s} from left to right, returning\n"
|
"Search through the string @var{s} from left to right, returning\n"
|
||||||
"the index of the first occurence of a character which\n"
|
"the index of the first occurrence of a character which\n"
|
||||||
"\n"
|
"\n"
|
||||||
"@itemize @bullet\n"
|
"@itemize @bullet\n"
|
||||||
"@item\n"
|
"@item\n"
|
||||||
"does not equal @var{char_pred}, if it is character,\n"
|
"does not equal @var{char_pred}, if it is character,\n"
|
||||||
"\n"
|
"\n"
|
||||||
"@item\n"
|
"@item\n"
|
||||||
"does not satisify the predicate @var{char_pred}, if it is a\n"
|
"does not satisfy the predicate @var{char_pred}, if it is a\n"
|
||||||
"procedure,\n"
|
"procedure,\n"
|
||||||
"\n"
|
"\n"
|
||||||
"@item\n"
|
"@item\n"
|
||||||
|
@ -1858,7 +1858,7 @@ SCM_DEFINE (scm_string_skip, "string-skip", 2, 2, 0,
|
||||||
SCM_DEFINE (scm_string_skip_right, "string-skip-right", 2, 2, 0,
|
SCM_DEFINE (scm_string_skip_right, "string-skip-right", 2, 2, 0,
|
||||||
(SCM s, SCM char_pred, SCM start, SCM end),
|
(SCM s, SCM char_pred, SCM start, SCM end),
|
||||||
"Search through the string @var{s} from right to left, returning\n"
|
"Search through the string @var{s} from right to left, returning\n"
|
||||||
"the index of the last occurence of a character which\n"
|
"the index of the last occurrence of a character which\n"
|
||||||
"\n"
|
"\n"
|
||||||
"@itemize @bullet\n"
|
"@itemize @bullet\n"
|
||||||
"@item\n"
|
"@item\n"
|
||||||
|
@ -1932,7 +1932,7 @@ SCM_DEFINE (scm_string_count, "string-count", 2, 2, 0,
|
||||||
"equals @var{char_pred}, if it is character,\n"
|
"equals @var{char_pred}, if it is character,\n"
|
||||||
"\n"
|
"\n"
|
||||||
"@item\n"
|
"@item\n"
|
||||||
"satisifies the predicate @var{char_pred}, if it is a procedure.\n"
|
"satisfies the predicate @var{char_pred}, if it is a procedure.\n"
|
||||||
"\n"
|
"\n"
|
||||||
"@item\n"
|
"@item\n"
|
||||||
"is in the set @var{char_pred}, if it is a character set.\n"
|
"is in the set @var{char_pred}, if it is a character set.\n"
|
||||||
|
@ -2459,7 +2459,7 @@ SCM_DEFINE (scm_string_concatenate_shared, "string-concatenate/shared", 1, 0, 0,
|
||||||
SCM_DEFINE (scm_string_concatenate_reverse_shared, "string-concatenate-reverse/shared", 1, 2, 0,
|
SCM_DEFINE (scm_string_concatenate_reverse_shared, "string-concatenate-reverse/shared", 1, 2, 0,
|
||||||
(SCM ls, SCM final_string, SCM end),
|
(SCM ls, SCM final_string, SCM end),
|
||||||
"Like @code{string-concatenate-reverse}, but the result may\n"
|
"Like @code{string-concatenate-reverse}, but the result may\n"
|
||||||
"share memory with the the strings in the @var{ls} arguments.")
|
"share memory with the strings in the @var{ls} arguments.")
|
||||||
#define FUNC_NAME s_scm_string_concatenate_reverse_shared
|
#define FUNC_NAME s_scm_string_concatenate_reverse_shared
|
||||||
{
|
{
|
||||||
/* Just call the non-sharing version. */
|
/* Just call the non-sharing version. */
|
||||||
|
@ -2969,7 +2969,7 @@ SCM_DEFINE (scm_string_tokenize, "string-tokenize", 1, 3, 0,
|
||||||
|
|
||||||
SCM_DEFINE (scm_string_split, "string-split", 2, 0, 0,
|
SCM_DEFINE (scm_string_split, "string-split", 2, 0, 0,
|
||||||
(SCM str, SCM chr),
|
(SCM str, SCM chr),
|
||||||
"Split the string @var{str} into the a list of the substrings delimited\n"
|
"Split the string @var{str} into a list of the substrings delimited\n"
|
||||||
"by appearances of the character @var{chr}. Note that an empty substring\n"
|
"by appearances of the character @var{chr}. Note that an empty substring\n"
|
||||||
"between separator characters will result in an empty string in the\n"
|
"between separator characters will result in an empty string in the\n"
|
||||||
"result list.\n"
|
"result list.\n"
|
||||||
|
|
|
@ -1363,7 +1363,7 @@ SCM_DEFINE (scm_ucs_range_to_char_set, "ucs-range->char-set", 2, 2, 0,
|
||||||
"If @var{error} is a true value, an error is signalled if the\n"
|
"If @var{error} is a true value, an error is signalled if the\n"
|
||||||
"specified range contains characters which are not valid\n"
|
"specified range contains characters which are not valid\n"
|
||||||
"Unicode code points. If @var{error} is @code{#f},\n"
|
"Unicode code points. If @var{error} is @code{#f},\n"
|
||||||
"these characters are silently left out of the resultung\n"
|
"these characters are silently left out of the resulting\n"
|
||||||
"character set.\n"
|
"character set.\n"
|
||||||
"\n"
|
"\n"
|
||||||
"The characters in @var{base_cs} are added to the result, if\n"
|
"The characters in @var{base_cs} are added to the result, if\n"
|
||||||
|
@ -1385,7 +1385,7 @@ SCM_DEFINE (scm_ucs_range_to_char_set_x, "ucs-range->char-set!", 4, 0, 0,
|
||||||
"If @var{error} is a true value, an error is signalled if the\n"
|
"If @var{error} is a true value, an error is signalled if the\n"
|
||||||
"specified range contains characters which are not contained in\n"
|
"specified range contains characters which are not contained in\n"
|
||||||
"the implemented character range. If @var{error} is @code{#f},\n"
|
"the implemented character range. If @var{error} is @code{#f},\n"
|
||||||
"these characters are silently left out of the resultung\n"
|
"these characters are silently left out of the resulting\n"
|
||||||
"character set.\n"
|
"character set.\n"
|
||||||
"\n"
|
"\n"
|
||||||
"The characters are added to @var{base_cs} and @var{base_cs} is\n"
|
"The characters are added to @var{base_cs} and @var{base_cs} is\n"
|
||||||
|
|
|
@ -160,7 +160,7 @@ scm_c_uniform_vector_ref (SCM v, size_t idx)
|
||||||
SCM_DEFINE (scm_uniform_vector_ref, "uniform-vector-ref", 2, 0, 0,
|
SCM_DEFINE (scm_uniform_vector_ref, "uniform-vector-ref", 2, 0, 0,
|
||||||
(SCM v, SCM idx),
|
(SCM v, SCM idx),
|
||||||
"Return the element at index @var{idx} of the\n"
|
"Return the element at index @var{idx} of the\n"
|
||||||
"homogenous numeric vector @var{v}.")
|
"homogeneous numeric vector @var{v}.")
|
||||||
#define FUNC_NAME s_scm_uniform_vector_ref
|
#define FUNC_NAME s_scm_uniform_vector_ref
|
||||||
{
|
{
|
||||||
return scm_c_uniform_vector_ref (v, scm_to_size_t (idx));
|
return scm_c_uniform_vector_ref (v, scm_to_size_t (idx));
|
||||||
|
@ -178,7 +178,7 @@ scm_c_uniform_vector_set_x (SCM v, size_t idx, SCM val)
|
||||||
SCM_DEFINE (scm_uniform_vector_set_x, "uniform-vector-set!", 3, 0, 0,
|
SCM_DEFINE (scm_uniform_vector_set_x, "uniform-vector-set!", 3, 0, 0,
|
||||||
(SCM v, SCM idx, SCM val),
|
(SCM v, SCM idx, SCM val),
|
||||||
"Set the element at index @var{idx} of the\n"
|
"Set the element at index @var{idx} of the\n"
|
||||||
"homogenous numeric vector @var{v} to @var{val}.")
|
"homogeneous numeric vector @var{v} to @var{val}.")
|
||||||
#define FUNC_NAME s_scm_uniform_vector_set_x
|
#define FUNC_NAME s_scm_uniform_vector_set_x
|
||||||
{
|
{
|
||||||
scm_c_uniform_vector_set_x (v, scm_to_size_t (idx), val);
|
scm_c_uniform_vector_set_x (v, scm_to_size_t (idx), val);
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue