Re: utf-translate-cjk-mode undocumented

[Luc Teirlinck <teirllm@dms.auburn.edu>]

Andreas Schwab wrote (in response to Richard Stallman:

   >     This is a minor-mode toggle.
   >
   > Could you fix the doc string accordingly?

   I think prepending "Toggle" to the doc string is enough to make it
   clear.  Do you agree?

The first line ia already six characters longer than the maximum
allowed 67 (for apropos).  It still does not mention that this is a
minor mode.  It does not say what the ARG argument does.  It refers to
the function as being a customizable _option_ (variable) in the last
paragraph.  I believe that the following would fix all of this:

===File ~/utf8.el-diff======================================
*** utf-8.el	13 Jun 2004 17:49:29 -0500	1.40
--- utf-8.el	30 Jul 2004 10:21:51 -0500	
***************
*** 284,290 ****
  	   (get 'utf-subst-table-for-encode 'translation-hash-table)))
    
  (define-minor-mode utf-translate-cjk-mode
!   "Whether the UTF based coding systems should decode/encode CJK characters.
  Enabling this allows the coding systems mule-utf-8,
  mule-utf-16le and mule-utf-16be to encode characters in the charsets
  `korean-ksc5601', `chinese-gb2312', `chinese-big5-1',
--- 284,292 ----
  	   (get 'utf-subst-table-for-encode 'translation-hash-table)))
    
  (define-minor-mode utf-translate-cjk-mode
!   "Toggle whether UTF based coding systems de/encode CJK characters.
! If ARG is an integer, enable if ARG is positive and disable if
! zero or negative.  This is a minor mode.
  Enabling this allows the coding systems mule-utf-8,
  mule-utf-16le and mule-utf-16be to encode characters in the charsets
  `korean-ksc5601', `chinese-gb2312', `chinese-big5-1',
***************
*** 296,304 ****
  turned on: ksc5601 for Korean, gb2312 for Chinese-GB, big5 for
  Chinese-Big5 and jisx for other environments.
  
! This option is on by default.  If you are not interested in CJK
  characters and want to avoid some overhead on encoding/decoding
! by the above coding systems, you can customize this option to nil."
    :init-value t
    :version "21.4"
    :type 'boolean
--- 298,307 ----
  turned on: ksc5601 for Korean, gb2312 for Chinese-GB, big5 for
  Chinese-Big5 and jisx for other environments.
  
! This is on by default.  If you are not interested in CJK
  characters and want to avoid some overhead on encoding/decoding
! by the above coding systems, you can customize the user option
! `utf-translate-cjk-mode' to nil."
    :init-value t
    :version "21.4"
    :type 'boolean
============================================================