diff options
| author | Juanma Barranquero | 2010-07-30 02:54:53 +0200 |
|---|---|---|
| committer | Juanma Barranquero | 2010-07-30 02:54:53 +0200 |
| commit | b756c005a9d036df325adda3f238c78aca0783c1 (patch) | |
| tree | da4f8f45364fac0a435a3c27bdd69fb90812a850 /src | |
| parent | ad9ae06519f6f4eb0be14f9f09101b349f0fe462 (diff) | |
| download | emacs-b756c005a9d036df325adda3f238c78aca0783c1.tar.gz emacs-b756c005a9d036df325adda3f238c78aca0783c1.zip | |
fns.c: Doc fixes.
Diffstat (limited to 'src')
| -rw-r--r-- | src/ChangeLog | 6 | ||||
| -rw-r--r-- | src/fns.c | 23 |
2 files changed, 17 insertions, 12 deletions
diff --git a/src/ChangeLog b/src/ChangeLog index 08680c1f7f5..9dd44716c74 100644 --- a/src/ChangeLog +++ b/src/ChangeLog | |||
| @@ -1,3 +1,9 @@ | |||
| 1 | 2010-07-30 Juanma Barranquero <lekktu@gmail.com> | ||
| 2 | |||
| 3 | * fns.c (Fsubstring_no_properties, Fnthcdr, Ffeaturep) | ||
| 4 | (Fhash_table_size): Fix typos in docstrings. | ||
| 5 | (Fmake_hash_table): Doc fix. | ||
| 6 | |||
| 1 | 2010-07-28 Juanma Barranquero <lekktu@gmail.com> | 7 | 2010-07-28 Juanma Barranquero <lekktu@gmail.com> |
| 2 | 8 | ||
| 3 | * minibuf.c (syms_of_minibuf) <read-buffer-function>: | 9 | * minibuf.c (syms_of_minibuf) <read-buffer-function>: |
| @@ -238,9 +238,8 @@ Symbols are also allowed; their print names are used instead. */) | |||
| 238 | return Qt; | 238 | return Qt; |
| 239 | } | 239 | } |
| 240 | 240 | ||
| 241 | DEFUN ("compare-strings", Fcompare_strings, | 241 | DEFUN ("compare-strings", Fcompare_strings, Scompare_strings, 6, 7, 0, |
| 242 | Scompare_strings, 6, 7, 0, | 242 | doc: /* Compare the contents of two strings, converting to multibyte if needed. |
| 243 | doc: /* Compare the contents of two strings, converting to multibyte if needed. | ||
| 244 | In string STR1, skip the first START1 characters and stop at END1. | 243 | In string STR1, skip the first START1 characters and stop at END1. |
| 245 | In string STR2, skip the first START2 characters and stop at END2. | 244 | In string STR2, skip the first START2 characters and stop at END2. |
| 246 | END1 and END2 default to the full lengths of the respective strings. | 245 | 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 | |||
| 1259 | 1258 | ||
| 1260 | DEFUN ("substring-no-properties", Fsubstring_no_properties, Ssubstring_no_properties, 1, 3, 0, | 1259 | DEFUN ("substring-no-properties", Fsubstring_no_properties, Ssubstring_no_properties, 1, 3, 0, |
| 1261 | doc: /* Return a substring of STRING, without text properties. | 1260 | doc: /* Return a substring of STRING, without text properties. |
| 1262 | It starts at index FROM and ending before TO. | 1261 | It starts at index FROM and ends before TO. |
| 1263 | TO may be nil or omitted; then the substring runs to the end of STRING. | 1262 | TO may be nil or omitted; then the substring runs to the end of STRING. |
| 1264 | If FROM is nil or omitted, the substring starts at the beginning of STRING. | 1263 | If FROM is nil or omitted, the substring starts at the beginning of STRING. |
| 1265 | If FROM or TO is negative, it counts from the end. | 1264 | If FROM or TO is negative, it counts from the end. |
| @@ -1355,7 +1354,7 @@ substring_both (string, from, from_byte, to, to_byte) | |||
| 1355 | } | 1354 | } |
| 1356 | 1355 | ||
| 1357 | DEFUN ("nthcdr", Fnthcdr, Snthcdr, 2, 2, 0, | 1356 | DEFUN ("nthcdr", Fnthcdr, Snthcdr, 2, 2, 0, |
| 1358 | doc: /* Take cdr N times on LIST, returns the result. */) | 1357 | doc: /* Take cdr N times on LIST, return the result. */) |
| 1359 | (n, list) | 1358 | (n, list) |
| 1360 | Lisp_Object n; | 1359 | Lisp_Object n; |
| 1361 | register Lisp_Object list; | 1360 | register Lisp_Object list; |
| @@ -1396,7 +1395,7 @@ DEFUN ("elt", Felt, Selt, 2, 2, 0, | |||
| 1396 | } | 1395 | } |
| 1397 | 1396 | ||
| 1398 | DEFUN ("member", Fmember, Smember, 2, 2, 0, | 1397 | DEFUN ("member", Fmember, Smember, 2, 2, 0, |
| 1399 | doc: /* Return non-nil if ELT is an element of LIST. Comparison done with `equal'. | 1398 | doc: /* Return non-nil if ELT is an element of LIST. Comparison done with `equal'. |
| 1400 | The value is actually the tail of LIST whose car is ELT. */) | 1399 | The value is actually the tail of LIST whose car is ELT. */) |
| 1401 | (elt, list) | 1400 | (elt, list) |
| 1402 | register Lisp_Object elt; | 1401 | register Lisp_Object elt; |
| @@ -1416,7 +1415,7 @@ The value is actually the tail of LIST whose car is ELT. */) | |||
| 1416 | } | 1415 | } |
| 1417 | 1416 | ||
| 1418 | DEFUN ("memq", Fmemq, Smemq, 2, 2, 0, | 1417 | DEFUN ("memq", Fmemq, Smemq, 2, 2, 0, |
| 1419 | doc: /* Return non-nil if ELT is an element of LIST. Comparison done with `eq'. | 1418 | doc: /* Return non-nil if ELT is an element of LIST. Comparison done with `eq'. |
| 1420 | The value is actually the tail of LIST whose car is ELT. */) | 1419 | The value is actually the tail of LIST whose car is ELT. */) |
| 1421 | (elt, list) | 1420 | (elt, list) |
| 1422 | register Lisp_Object elt, list; | 1421 | register Lisp_Object elt, list; |
| @@ -1443,7 +1442,7 @@ The value is actually the tail of LIST whose car is ELT. */) | |||
| 1443 | } | 1442 | } |
| 1444 | 1443 | ||
| 1445 | DEFUN ("memql", Fmemql, Smemql, 2, 2, 0, | 1444 | DEFUN ("memql", Fmemql, Smemql, 2, 2, 0, |
| 1446 | doc: /* Return non-nil if ELT is an element of LIST. Comparison done with `eql'. | 1445 | doc: /* Return non-nil if ELT is an element of LIST. Comparison done with `eql'. |
| 1447 | The value is actually the tail of LIST whose car is ELT. */) | 1446 | The value is actually the tail of LIST whose car is ELT. */) |
| 1448 | (elt, list) | 1447 | (elt, list) |
| 1449 | register Lisp_Object elt; | 1448 | register Lisp_Object elt; |
| @@ -2829,7 +2828,7 @@ Lisp_Object Vfeatures, Qsubfeatures; | |||
| 2829 | extern Lisp_Object Vafter_load_alist; | 2828 | extern Lisp_Object Vafter_load_alist; |
| 2830 | 2829 | ||
| 2831 | DEFUN ("featurep", Ffeaturep, Sfeaturep, 1, 2, 0, | 2830 | DEFUN ("featurep", Ffeaturep, Sfeaturep, 1, 2, 0, |
| 2832 | doc: /* Returns t if FEATURE is present in this Emacs. | 2831 | doc: /* Return t if FEATURE is present in this Emacs. |
| 2833 | 2832 | ||
| 2834 | Use this to conditionalize execution of lisp code based on the | 2833 | Use this to conditionalize execution of lisp code based on the |
| 2835 | presence or absence of Emacs or environment extensions. | 2834 | 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 | |||
| 4627 | multiplying the old size with that factor. Default is 1.5. | 4626 | multiplying the old size with that factor. Default is 1.5. |
| 4628 | 4627 | ||
| 4629 | :rehash-threshold THRESHOLD -- THRESHOLD must a float > 0, and <= 1.0. | 4628 | :rehash-threshold THRESHOLD -- THRESHOLD must a float > 0, and <= 1.0. |
| 4630 | Resize the hash table when ratio of the number of entries in the | 4629 | Resize the hash table when the ratio (number of entries / table size) |
| 4631 | table. Default is 0.8. | 4630 | is greater or equal than THRESHOLD. Default is 0.8. |
| 4632 | 4631 | ||
| 4633 | :weakness WEAK -- WEAK must be one of nil, t, `key', `value', | 4632 | :weakness WEAK -- WEAK must be one of nil, t, `key', `value', |
| 4634 | `key-or-value', or `key-and-value'. If WEAK is not nil, the table | 4633 | `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, | |||
| 4757 | DEFUN ("hash-table-size", Fhash_table_size, Shash_table_size, 1, 1, 0, | 4756 | DEFUN ("hash-table-size", Fhash_table_size, Shash_table_size, 1, 1, 0, |
| 4758 | doc: /* Return the size of TABLE. | 4757 | doc: /* Return the size of TABLE. |
| 4759 | The size can be used as an argument to `make-hash-table' to create | 4758 | The size can be used as an argument to `make-hash-table' to create |
| 4760 | a hash table than can hold as many elements of TABLE holds | 4759 | a hash table than can hold as many elements as TABLE holds |
| 4761 | without need for resizing. */) | 4760 | without need for resizing. */) |
| 4762 | (table) | 4761 | (table) |
| 4763 | Lisp_Object table; | 4762 | Lisp_Object table; |