all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Richard M. Stallman" <rms@gnu.org>
Cc: emacs-devel@gnu.org
Subject: Re: how to retrieve doc string for a face...
Date: Sun, 20 Nov 2005 18:23:43 -0500	[thread overview]
Message-ID: <E1EdyX9-0001y1-4L@fencepost.gnu.org> (raw)
In-Reply-To: <MEEKKIABFKKDFJMPIOEBMEJCCNAA.drew.adams@oracle.com>

    It says nothing about retrieving the doc string supplied with `defface' or
    `defgroup' or `defmacro' or ....

    1. How are those doc strings retrieved? (e.g. `face-documentation')

    2. Shouldn't that retrieval be documented too?

I will doc these.

    3. Info mentions the `function-documentation' property, in parallel with the
    `variable-documentation' property. Is there no equivalent shortcut to
    `documentation-property' for retrieving the doc string of a keyboard macro,
    so that you must use `get'?

As far as I know, the only way a keyboard macro can have a doc string
is if it has a function name and that symbol has a
`function-documentation' property.  Is that correct?

*** help.texi	11 Aug 2005 08:30:32 -0400	1.25
--- help.texi	20 Nov 2005 17:28:19 -0500	
***************
*** 133,143 ****
--- 133,149 ----
  (symbol-plist 'command-line-processed)
       @result{} (variable-documentation 188902)
  @end group
+ @group
+ (documentation-property 'emacs 'group-documentation)
+      @result{} "Customization of the One True Editor."
+ @end group
  @end smallexample
  @end defun
  
  @defun documentation function &optional verbatim
  This function returns the documentation string of @var{function}.
+ @code{documentation} handles macros, named keyboard macros, and
+ special forms, as well as ordinary functions.
  
  If @var{function} is a symbol, this function first looks for the
  @code{function-documentation} property of that symbol; if that has a
***************
*** 155,160 ****
--- 161,171 ----
  if @var{function} has no function definition.  However, it is OK if
  the function definition has no documentation string.  In that case,
  @code{documentation} returns @code{nil}.
+ @end defun
+ 
+ @defun face-documentation face
+ This function returns the documentation string of @var{face} as a
+ face.
  @end defun
  
  @c Wordy to prevent overfull hboxes.  --rjc 15mar92


    This business of retrieving doc strings doesn't seem very homogeneous - it
    seems ad hoc. Shouldn't there be a simple, single way to get the doc
    string(s) of an object?

No.  I don't want to make changes in Emacs just to for the sake of
increased consistency in fairly minor areas like this one.

      reply	other threads:[~2005-11-20 23:23 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-11-20  7:53 how to retrieve doc string for a face Drew Adams
2005-11-20 23:23 ` Richard M. Stallman [this message]

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

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

  git send-email \
    --in-reply-to=E1EdyX9-0001y1-4L@fencepost.gnu.org \
    --to=rms@gnu.org \
    --cc=emacs-devel@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.
Code repositories for project(s) associated with this external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.