From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Subject: [PATCH 4/7] doc/emacs: split index category from label
Date: Sun, 31 Jul 2022 08:33:20 -0300 [thread overview]
Message-ID: <20220731113323.2845595-5-david@tethera.net> (raw)
In-Reply-To: <20220731113323.2845595-1-david@tethera.net>
A more verbose category is needed for the index, but not the
description in the manual.
---
doc/elisp.py | 14 +++++++++++++-
1 file changed, 13 insertions(+), 1 deletion(-)
diff --git a/doc/elisp.py b/doc/elisp.py
index b8b4931b..1b0392e6 100644
--- a/doc/elisp.py
+++ b/doc/elisp.py
@@ -110,6 +110,13 @@ class EmacsLispSymbol(ObjectDescription):
'defface': 'face'
}
+ category_for_objtype = {
+ 'defcustom': 'Emacs variable (customizable)',
+ 'defconst': 'Emacs constant',
+ 'defvar': 'Emacs variable',
+ 'defface': 'Emacs face'
+ }
+
@property
def cell(self):
"""The cell in which to store symbol metadata."""
@@ -120,6 +127,11 @@ class EmacsLispSymbol(ObjectDescription):
"""The label for the documented object type."""
return self.objtype
+ @property
+ def category(self):
+ """Index category"""
+ return self.category_for_objtype[self.objtype]
+
def handle_signature(self, signature, signode):
"""Create nodes in ``signode`` for the ``signature``.
@@ -137,7 +149,7 @@ class EmacsLispSymbol(ObjectDescription):
def _add_index(self, name, target):
index_text = '{name}; {label}'.format(
- name=name, label=self.label)
+ name=name, label=self.category)
self.indexnode['entries'].append(
('pair', index_text, target, '', None))
--
2.35.2
next prev parent reply other threads:[~2022-07-31 11:34 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-31 11:33 Embed elisp.py from flycheck, use it in notmuch-emacs doc David Bremner
2022-07-31 11:33 ` [PATCH 1/7] doc: copy elisp.py from flycheck, make available David Bremner
2022-07-31 11:33 ` [PATCH 2/7] doc/elisp: replace label for Emacs commands and key bindings David Bremner
2022-07-31 11:33 ` [PATCH 3/7] doc/emacs: drop domain label David Bremner
2022-07-31 11:33 ` David Bremner [this message]
2022-07-31 11:33 ` [PATCH 5/7] doc/emacs: replace emacscmd with el:define-key David Bremner
2022-07-31 11:33 ` [PATCH 6/7] doc/emacs: replace use of emacsvar with el:defcustom David Bremner
2022-07-31 11:33 ` [PATCH 7/7] doc/emacs: use define-key instead of hard-coding markup David Bremner
2022-08-10 20:09 ` Embed elisp.py from flycheck, use it in notmuch-emacs doc Tomi Ollila
2022-08-11 10:51 ` David Bremner
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://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220731113323.2845595-5-david@tethera.net \
--to=david@tethera.net \
--cc=notmuch@notmuchmail.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 public inbox
https://yhetil.org/notmuch.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).