unofficial mirror of help-gnu-emacs@gnu.org
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
Subject: Re: I think the doc in emacs is too simple in someplaces
Date: Mon, 18 Dec 2006 22:06:50 +0200	[thread overview]
Message-ID: <ulkl5m0it.fsf@gnu.org> (raw)
In-Reply-To: <em6aht$v4q$1@news.yaako.com> (message from Ronald on Mon, 18 Dec 2006 23:02:04 +0800)

> From: Ronald <followait@163.com>
> Date: Mon, 18 Dec 2006 23:02:04 +0800
> 
> For example:
> 
> c-toggle-electric-state
> 
> c-toggle-electric-state is an interactive compiled Lisp function in 
> `cc-cmds.el'.
> It is bound to C-c C-l, <menu-bar> <C> <Toggle...> <Electric mode>.
> (c-toggle-electric-state &optional ARG)
> 
> Toggle the electric indentation feature.
> Optional numeric ARG, if supplied, turns on electric indentation when
> positive, turns it off when negative, and just toggles it when zero or
> left out.
> 
> 
> It doesn't tell what the function does.
> And the description about ARG is repeated everywhere,
> I supposed it's not good.

I agree, but please submit bug reports such as this one to the correct
forum; "M-x report-emacs-bug RET" will do that for you automatically.
Also, please report specifically each case of insufficient
documentation; ``for example'' is not good enough, because Emacs has
thousands of doc strings, and no one can possibly believe that all of
them are bad.

  parent reply	other threads:[~2006-12-18 20:06 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-12-18 15:02 I think the doc in emacs is too simple in someplaces Ronald
2006-12-18 16:03 ` Robert D. Crawford
2006-12-19  0:15   ` Ronald
2006-12-19  8:28     ` Tassilo Horn
2006-12-19  9:33     ` Robert D. Crawford
2006-12-18 20:06 ` Eli Zaretskii [this message]
     [not found] ` <mailman.2081.1166472416.2155.help-gnu-emacs@gnu.org>
2006-12-19  0:18   ` Ronald

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ulkl5m0it.fsf@gnu.org \
    --to=eliz@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).