# HG changeset patch # User Juanma Barranquero # Date 1180397693 0 # Node ID 4f7df84e666c802e562bee246111c14be418846f # Parent 848729201b1c1f13ef2ceb348e9c97cfdb9576b2 (toggle-enable-multibyte-characters, sort-coding-systems, search-unencodable-char): Doc fixes. (default-input-method, input-method-verbose-flag, input-method-highlight-flag): Remove * in defcustom's docstrings. (exit-language-environment-hook, set-default-coding-systems, coding-system-change-eol-conversion, prefer-coding-system, find-multibyte-characters, leim-list-entry-regexp, set-input-method, input-method-exit-on-first-char, princ-list, locale-language-names, locale-charset-language-names, define-char-code-property): Fix typos in docstrings. diff -r 848729201b1c -r 4f7df84e666c lisp/international/mule-cmds.el --- a/lisp/international/mule-cmds.el Mon May 28 11:59:10 2007 +0000 +++ b/lisp/international/mule-cmds.el Tue May 29 00:14:53 2007 +0000 @@ -1,4 +1,4 @@ -;;; mule-cmds.el --- commands for mulitilingual environment -*-coding: iso-2022-7bit -*- +;;; mule-cmds.el --- commands for multilingual environment -*-coding: iso-2022-7bit -*- ;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, ;; 2006, 2007 Free Software Foundation, Inc. @@ -206,7 +206,7 @@ "`\\(\\sw\\(\\sw\\|\\s_\\)+\\)'"))) (defun coding-system-change-eol-conversion (coding-system eol-type) - "Return a coding system which differs from CODING-SYSTEM in eol conversion. + "Return a coding system which differs from CODING-SYSTEM in EOL conversion. The returned coding system converts end-of-line by EOL-TYPE but text as the same way as CODING-SYSTEM. EOL-TYPE should be `unix', `dos', `mac', or nil. @@ -256,8 +256,8 @@ In general, therefore, this command *changes* the sequence of characters that the current buffer contains. -We suggest you avoid using use this command unless you know what you -are doing. If you use it by mistake, and the buffer is now displayed +We suggest you avoid using this command unless you know what you are +doing. If you use it by mistake, and the buffer is now displayed wrong, use this command again to toggle back to the right mode." (interactive "P") (let ((new-flag @@ -330,10 +330,10 @@ o default coding system for subprocess I/O This also sets the following values: o default value used as `file-name-coding-system' for converting file names - if CODING-SYSTEM is ASCII-compatible. + if CODING-SYSTEM is ASCII-compatible o default value for the command `set-terminal-coding-system' (not on MSDOS) o default value for the command `set-keyboard-coding-system' - if CODING-SYSTEM is ASCII-compatible.." + if CODING-SYSTEM is ASCII-compatible" (check-coding-system coding-system) (setq-default buffer-file-coding-system coding-system) (if (fboundp 'ucs-set-table-for-input) @@ -373,7 +373,7 @@ o coding system of a newly created buffer o default coding system for subprocess I/O This also sets the following values: - o default value used as `file-name-coding-system' for converting file names. + o default value used as `file-name-coding-system' for converting file names o default value for the command `set-terminal-coding-system' (not on MSDOS) o default value for the command `set-keyboard-coding-system' @@ -415,16 +415,16 @@ (defun sort-coding-systems (codings) "Sort coding system list CODINGS by a priority of each coding system. -Returns the sorted list. CODINGS is modified by side effects. +Return the sorted list. CODINGS is modified by side effects. If a coding system is most preferred, it has the highest priority. -Otherwise, a coding system corresponds to some MIME charset has higher -priorities. Among them, a coding system included in `coding-system' -key of the current language environment has higher priorities. See -also the documentation of `language-info-alist'. +Otherwise, coding systems that correspond to MIME charsets have +higher priorities. Among them, a coding system included in the +`coding-system' key of the current language environment has higher +priority. See also the documentation of `language-info-alist'. If the variable `sort-coding-systems-predicate' (which see) is -non-nil, it is used to sort CODINGS in the different way than above." +non-nil, it is used to sort CODINGS instead." (if sort-coding-systems-predicate (sort codings sort-coding-systems-predicate) (let* ((from-priority (coding-system-priority-list)) @@ -556,7 +556,7 @@ COUNT is a number of characters, CHARs are the characters found from the character set. Optional 3rd arg MAXCOUNT limits how many CHARs are put in the above list. -Optional 4th arg EXCLUDE is a list of character sets to be ignored." +Optional 4th arg EXCLUDES is a list of character sets to be ignored." (let ((chars nil) charset char) (if (stringp from) @@ -598,8 +598,8 @@ If such a character is found, set point after that character. Otherwise, don't move point. -When called from a program, the value is a position of the found character, -or nil if all characters are encodable." +When called from a program, the value is the position of the unencodable +character found, or nil if all characters are encodable." (interactive (list (let ((default (or buffer-file-coding-system 'us-ascii))) (read-coding-system @@ -1261,7 +1261,7 @@ (defvar leim-list-entry-regexp "^(register-input-method" "Regexp matching head of each entry in LEIM list file. -See also the variable `leim-list-header'") +See also the variable `leim-list-header'.") (defvar update-leim-list-functions '(quail-update-leim-list-file) @@ -1287,7 +1287,7 @@ (put 'current-input-method-title 'permanent-local t) (defcustom default-input-method nil - "*Default input method for multilingual text (a string). + "Default input method for multilingual text (a string). This is the input method activated automatically by the command `toggle-input-method' (\\[toggle-input-method])." :link '(custom-manual "(emacs)Input Methods") @@ -1445,7 +1445,7 @@ which marks the variable `default-input-method' as set for Custom buffers. To deactivate the input method interactively, use \\[toggle-input-method]. -To deactivate it programmatically, use \\[inactivate-input-method]." +To deactivate it programmatically, use `inactivate-input-method'." (interactive (let* ((default (or (car input-method-history) default-input-method))) (list (read-input-method-name @@ -1566,7 +1566,7 @@ ;; should react to these variables. (defcustom input-method-verbose-flag 'default - "*A flag to control extra guidance given by input methods. + "A flag to control extra guidance given by input methods. The value should be nil, t, `complex-only', or `default'. The extra guidance is done by showing list of available keys in echo @@ -1589,7 +1589,7 @@ :group 'mule) (defcustom input-method-highlight-flag t - "*If this flag is non-nil, input methods highlight partially-entered text. + "If this flag is non-nil, input methods highlight partially-entered text. For instance, while you are in the middle of a Quail input method sequence, the text inserted so far is temporarily underlined. The underlining goes away when you finish or abort the input method sequence. @@ -1622,7 +1622,7 @@ "This flag controls when an input method returns. Usually, the input method does not return while there's a possibility that it may find a different translation if a user types another key. -But, it this flag is non-nil, the input method returns as soon as +But, if this flag is non-nil, the input method returns as soon as the current key sequence gets long enough to have some valid translation.") (defcustom input-method-use-echo-area nil @@ -1658,7 +1658,7 @@ is still bound to the language environment being exited. This hook is mainly used for canceling the effect of -`set-language-environment-hook' (which-see)." +`set-language-environment-hook' (which see)." :type 'hook :group 'mule) @@ -1968,7 +1968,7 @@ (set-display-table-and-terminal-coding-system language-name)) (defsubst princ-list (&rest args) - "Print all arguments with `princ', then print \"\n\"." + "Print all arguments with `princ', then print \"\\n\"." (while args (princ (car args)) (setq args (cdr args))) (princ "\n")) @@ -2299,10 +2299,10 @@ ("wen" . "Latin-2") ; MS Windows Upper Sorbian )) "Alist of locale regexps vs the corresponding languages and coding systems. -Each element has these form: +Each element has this form: \(LOCALE-REGEXP LANG-ENV CODING-SYSTEM) The first element whose LOCALE-REGEXP matches the start of a -downcased locale specifies the LANG-ENV \(language environtment) +downcased locale specifies the LANG-ENV \(language environment) and CODING-SYSTEM corresponding to that locale. If there is no appropriate language environment, the element may have this form: \(LOCALE-REGEXP . LANG-ENV) @@ -2326,7 +2326,7 @@ The first element whose locale regexp matches the start of a downcased locale specifies the language name whose charset corresponds to that locale. This language name is used if the locale is not listed in -`locale-language-names'") +`locale-language-names'.") (defconst locale-preferred-coding-systems (purecopy @@ -2647,7 +2647,7 @@ these extra slots: 1st: NAME. 2nd: Function to call to get a property value of a character. - It is called with three arugments CHAR, VAL, and TABLE, where + It is called with three arguments CHAR, VAL, and TABLE, where CHAR is a character, VAL is the value of (aref TABLE CHAR). 3rd: Function to call to put a property value of a character. It is called with the same arguments as above.