Mercurial > hg > xemacs-beta
diff src/editfns.c @ 4469:c661944aa259
Fill out docstrings for #'translate-region, #'make-char-table.
2008-05-25 Aidan Kehoe <kehoea@parhasard.net>
* chartab.c (Fmake_char_table):
Document the default return values for the various char table
types.
* editfns.c (Ftranslate_region): Document why `generic' char tables
are preferable to `char' char tables for this function.
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Sun, 25 May 2008 22:54:33 +0200 |
| parents | d9eb5ea14f65 |
| children | c76b1bc6bd28 |
line wrap: on
line diff
--- a/src/editfns.c Sun May 25 21:11:35 2008 +0200 +++ b/src/editfns.c Sun May 25 22:54:33 2008 +0200 @@ -1824,8 +1824,12 @@ nil (nil meaning don't replace.) If TABLE is a char-table, its elements describe the mapping between -characters and their replacements. The char-table should be of type -`char' or `generic'. +characters and their replacements. The char-table should be of type `char' +or `generic'. If the value given by `put-char-table' for a given character +is nil, that character will not be translated by `translate-region'. Since +`char' char-tables can never return nil to `put-char-table', and since most +translation involves a subset of the possible XEmacs characters, not all of +them, the most generally useful table type here is `generic'. Returns the number of substitutions performed. */