all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Jambunathan K <kjambunathan@gmail.com>
To: 10823@debbugs.gnu.org
Subject: bug#10823: 24.0.93; Make `C-h d' reporting more consistent and usable
Date: Thu, 16 Feb 2012 10:33:42 +0530	[thread overview]
Message-ID: <81booznzdd.fsf@gmail.com> (raw)


I find that C-h d gives me a fairly good coverage of a particular
"feature" that I am trying to hunt down. Unfortunately for the amount of
information that it prints, the navigation of the *Apropos* buffer is
cumbersome.

Let me explain with an explain. Down below is a snapshot of first few
paragraphs when I do a

  C-h d apropos

Here are a few things that I find noisome. These are documented in the
text below.


----------------
apropos-read-pattern
  Function: Read an apropos pattern, either a word list or a regexp.

<<Big wall of text>>

(fn SUBJECT) 

,---- ^^^^^^^^^^^^^^
| By the time I reach here, I have almost forgotten what "fn" I am looking
| at. I also find this style of reporting inconsisten with C-h v and C-h f
| style of reporting where the function signature is on the top.
`----

----------------

,---- ^^^^^^^^^^^^^^
| Can these separators be converted to page breaks? So that I can move
| between the different blocks using page navigation commands. Doing a
| incremental re-search for -----+ is painful particularly when some of
| the listed commands that have docstring which have horizontal rules in
| them.
`----

apropos
  Command: Show all meaningful Lisp symbols whose names match PATTERN.

<<Another big wall of text>>

(fn PATTERN &optional DO-ALL)

----------------
apropos-command
  Command: Show commands (interactively callable functions) that match
           PATTERN.


,----[ C-h v internal-doc-file-name RET ]
| internal-doc-file-name is a variable defined in `C source code'.
| Its value is "DOC-X"
| 
| Documentation:
| Name of file containing documentation strings of built-in symbols.
| 
| [back]
`----

,----
| Can someone clarify what the file is and what qualifies as "built-in"
| symbols. Does it include the "whole" of what ships with vanilla Emacs or
| just a subset of it. I tried looking around in the info manual. I found
| nothing much which could give me a sense of "coverage" of the reported
| list.
`----





             reply	other threads:[~2012-02-16  5:03 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-02-16  5:03 Jambunathan K [this message]
2012-02-16 13:48 ` bug#10823: 24.0.93; Make `C-h d' reporting more consistent and usable Stefan Monnier
2013-11-15  4:35 ` Jambunathan K

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=81booznzdd.fsf@gmail.com \
    --to=kjambunathan@gmail.com \
    --cc=10823@debbugs.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.