Mercurial > hg > xemacs-beta
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 4468:a78d697ccd2c | 4469:c661944aa259 |
|---|---|
| 1822 If TABLE is a vector, its Nth element is the mapping for character | 1822 If TABLE is a vector, its Nth element is the mapping for character |
| 1823 with code N. The values of elements may be characters, strings, or | 1823 with code N. The values of elements may be characters, strings, or |
| 1824 nil (nil meaning don't replace.) | 1824 nil (nil meaning don't replace.) |
| 1825 | 1825 |
| 1826 If TABLE is a char-table, its elements describe the mapping between | 1826 If TABLE is a char-table, its elements describe the mapping between |
| 1827 characters and their replacements. The char-table should be of type | 1827 characters and their replacements. The char-table should be of type `char' |
| 1828 `char' or `generic'. | 1828 or `generic'. If the value given by `put-char-table' for a given character |
| 1829 is nil, that character will not be translated by `translate-region'. Since | |
| 1830 `char' char-tables can never return nil to `put-char-table', and since most | |
| 1831 translation involves a subset of the possible XEmacs characters, not all of | |
| 1832 them, the most generally useful table type here is `generic'. | |
| 1829 | 1833 |
| 1830 Returns the number of substitutions performed. | 1834 Returns the number of substitutions performed. |
| 1831 */ | 1835 */ |
| 1832 (start, end, table)) | 1836 (start, end, table)) |
| 1833 { | 1837 { |