Commit b756c005 authored by Juanma Barranquero's avatar Juanma Barranquero
Browse files

fns.c: Doc fixes.

parent ad9ae065
2010-07-30 Juanma Barranquero <lekktu@gmail.com>
* fns.c (Fsubstring_no_properties, Fnthcdr, Ffeaturep)
(Fhash_table_size): Fix typos in docstrings.
(Fmake_hash_table): Doc fix.
2010-07-28 Juanma Barranquero <lekktu@gmail.com>
* minibuf.c (syms_of_minibuf) <read-buffer-function>:
......
......@@ -238,9 +238,8 @@ Symbols are also allowed; their print names are used instead. */)
return Qt;
}
DEFUN ("compare-strings", Fcompare_strings,
Scompare_strings, 6, 7, 0,
doc: /* Compare the contents of two strings, converting to multibyte if needed.
DEFUN ("compare-strings", Fcompare_strings, Scompare_strings, 6, 7, 0,
doc: /* Compare the contents of two strings, converting to multibyte if needed.
In string STR1, skip the first START1 characters and stop at END1.
In string STR2, skip the first START2 characters and stop at END2.
END1 and END2 default to the full lengths of the respective strings.
......@@ -1259,7 +1258,7 @@ value is a new vector that contains the elements between index FROM
DEFUN ("substring-no-properties", Fsubstring_no_properties, Ssubstring_no_properties, 1, 3, 0,
doc: /* Return a substring of STRING, without text properties.
It starts at index FROM and ending before TO.
It starts at index FROM and ends before TO.
TO may be nil or omitted; then the substring runs to the end of STRING.
If FROM is nil or omitted, the substring starts at the beginning of STRING.
If FROM or TO is negative, it counts from the end.
......@@ -1355,7 +1354,7 @@ substring_both (string, from, from_byte, to, to_byte)
}
DEFUN ("nthcdr", Fnthcdr, Snthcdr, 2, 2, 0,
doc: /* Take cdr N times on LIST, returns the result. */)
doc: /* Take cdr N times on LIST, return the result. */)
(n, list)
Lisp_Object n;
register Lisp_Object list;
......@@ -1396,7 +1395,7 @@ DEFUN ("elt", Felt, Selt, 2, 2, 0,
}
DEFUN ("member", Fmember, Smember, 2, 2, 0,
doc: /* Return non-nil if ELT is an element of LIST. Comparison done with `equal'.
doc: /* Return non-nil if ELT is an element of LIST. Comparison done with `equal'.
The value is actually the tail of LIST whose car is ELT. */)
(elt, list)
register Lisp_Object elt;
......@@ -1416,7 +1415,7 @@ The value is actually the tail of LIST whose car is ELT. */)
}
DEFUN ("memq", Fmemq, Smemq, 2, 2, 0,
doc: /* Return non-nil if ELT is an element of LIST. Comparison done with `eq'.
doc: /* Return non-nil if ELT is an element of LIST. Comparison done with `eq'.
The value is actually the tail of LIST whose car is ELT. */)
(elt, list)
register Lisp_Object elt, list;
......@@ -1443,7 +1442,7 @@ The value is actually the tail of LIST whose car is ELT. */)
}
DEFUN ("memql", Fmemql, Smemql, 2, 2, 0,
doc: /* Return non-nil if ELT is an element of LIST. Comparison done with `eql'.
doc: /* Return non-nil if ELT is an element of LIST. Comparison done with `eql'.
The value is actually the tail of LIST whose car is ELT. */)
(elt, list)
register Lisp_Object elt;
......@@ -2829,7 +2828,7 @@ Lisp_Object Vfeatures, Qsubfeatures;
extern Lisp_Object Vafter_load_alist;
DEFUN ("featurep", Ffeaturep, Sfeaturep, 1, 2, 0,
doc: /* Returns t if FEATURE is present in this Emacs.
doc: /* Return t if FEATURE is present in this Emacs.
Use this to conditionalize execution of lisp code based on the
presence or absence of Emacs or environment extensions.
......@@ -4627,8 +4626,8 @@ is a float, it must be > 1.0, and the new size is computed by
multiplying the old size with that factor. Default is 1.5.
:rehash-threshold THRESHOLD -- THRESHOLD must a float > 0, and <= 1.0.
Resize the hash table when ratio of the number of entries in the
table. Default is 0.8.
Resize the hash table when the ratio (number of entries / table size)
is greater or equal than THRESHOLD. Default is 0.8.
:weakness WEAK -- WEAK must be one of nil, t, `key', `value',
`key-or-value', or `key-and-value'. If WEAK is not nil, the table
......@@ -4757,7 +4756,7 @@ DEFUN ("hash-table-rehash-threshold", Fhash_table_rehash_threshold,
DEFUN ("hash-table-size", Fhash_table_size, Shash_table_size, 1, 1, 0,
doc: /* Return the size of TABLE.
The size can be used as an argument to `make-hash-table' to create
a hash table than can hold as many elements of TABLE holds
a hash table than can hold as many elements as TABLE holds
without need for resizing. */)
(table)
Lisp_Object table;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment