unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
Subject: RE: doc string for face-attribute-relative-p doesn't help
Date: Mon, 26 Jun 2006 20:33:03 -0700	[thread overview]
Message-ID: <EIENLHALHGIMHGDOLMIMEECJCJAA.drew.adams@oracle.com> (raw)
In-Reply-To: <buo4py7tknx.fsf@dhapc248.dev.necel.com>

    > I don't think so. It isn't clear to me, even after reading it
    > a couple of times.

    It seems to me that the real problem is a lack of knowledge about how
    face rendering in general works.

    This should be solved by having a good overview of face rendering in the
    manual (I don't know if there is one or not), not by trying to shove
    that information in every function docstring that's somehow related to
    faces.

Yes, such an explanation in the manual is probably needed - that's what I
was trying to suggest. Whether it should take the form of a new, separate
section or just cleanup of existing text, I don't know. If a new section is
added, the existing text should still be cleaned up so that it makes more
sense (possibly cross-referencing the new section, to help).

I agree, too, that each function's doc string need not try to explain
everything. If the doc defines the terms it uses (e.g. "underlying",
"relative") and explains them clearly, then that lessens the burden of
explanation for doc strings.

  reply	other threads:[~2006-06-27  3:33 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <MEEKKIABFKKDFJMPIOEBKEIGDCAA.drew.adams@oracle.com>
2006-06-25 15:33 ` doc string for face-attribute-relative-p doesn't help Richard Stallman
2006-06-26  4:39   ` Miles Bader
2006-06-26  7:45     ` David Kastrup
2006-06-26 16:17       ` Drew Adams
2006-06-27  2:08         ` Miles Bader
2006-06-27  3:33           ` Drew Adams [this message]
2006-06-27  3:52             ` Miles Bader
2006-06-27  4:27               ` Drew Adams
2006-06-27 16:16               ` Richard Stallman
2006-06-28  6:41                 ` Miles Bader
2006-06-26 11:13     ` John S. Yates, Jr.
2006-06-26 10:57       ` Miles Bader
2006-06-26 12:28         ` John S. Yates, Jr.
2006-06-27  2:12           ` Miles Bader

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=EIENLHALHGIMHGDOLMIMEECJCJAA.drew.adams@oracle.com \
    --to=drew.adams@oracle.com \
    /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.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

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).