unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Subject: [PATCH 5/7] doc/emacs: replace emacscmd with el:define-key
Date: Sun, 31 Jul 2022 08:33:21 -0300	[thread overview]
Message-ID: <20220731113323.2845595-6-david@tethera.net> (raw)
In-Reply-To: <20220731113323.2845595-1-david@tethera.net>

This allows us to eliminate the ad-hoc emacscmd directive / role, and
improve indexing.

doc/emacs: convert remaining uses of emacscmd to define-key

This allows us to remove the no-longer used object type.
---
 doc/conf.py           |  5 -----
 doc/notmuch-emacs.rst | 14 ++++++++------
 2 files changed, 8 insertions(+), 11 deletions(-)

diff --git a/doc/conf.py b/doc/conf.py
index 503255b5..0b7b8af5 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -228,8 +228,3 @@ def setup(app):
                         indextemplate='pair: Emacs variable; %s',
                         ref_nodeclass=docutils.nodes.generated,
                         objname='Emacs variable')
-    app.add_object_type('emacscmd','emacscmd',
-                        indextemplate='pair: Emacs command; %s',
-                        ref_nodeclass=docutils.nodes.generated,
-                        objname='Emacs command')
-
diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst
index e69bd23d..b7656fe1 100644
--- a/doc/notmuch-emacs.rst
+++ b/doc/notmuch-emacs.rst
@@ -543,7 +543,7 @@ following key bindings:
 ``k``
     Tagging operations using :ref:`notmuch-tag-jump`
 
-``C-_`` ``C-/`` ``C-x u``: Undo previous tagging operation using :ref:`notmuch-tag-undo`
+``C-_`` ``C-/`` ``C-x u``: Undo previous tagging operation using :any:`notmuch-tag-undo`
 
 .. _notmuch-jump:
 
@@ -574,7 +574,6 @@ operations specified in ``notmuch-tagging-keys``; i.e. each
 
   |docstring::notmuch-tagging-keys|
 
-.. _notmuch-tag-undo:
 
 notmuch-tag-undo
 ----------------
@@ -582,17 +581,20 @@ notmuch-tag-undo
 Each notmuch buffer supporting tagging operations (i.e buffers in
 :any:`notmuch-show`, :any:`notmuch-search`, :any:`notmuch-tree`, and
 :any:`notmuch-unthreaded` mode) keeps a local stack of tagging
-operations. These can be undone via :emacscmd:`notmuch-tag-undo`. By default
+operations. These can be undone via :any:`notmuch-tag-undo`. By default
 this is bound to the usual Emacs keys for undo.
 
-.. emacscmd:: notmuch-tag-undo
+.. el:define-key::  C-_
+   C-/
+   C-x u
+   M-x notmuch-tag-undo
 
    |docstring::notmuch-tag-undo|
 
 Buffer navigation
 =================
 
-.. emacscmd:: notmuch-cycle-notmuch-buffers
+.. el:define-key:: M-x notmuch-cycle-notmuch-buffers
 
    |docstring::notmuch-cycle-notmuch-buffers|
 
@@ -604,7 +606,7 @@ Configuration
 Importing Mail
 --------------
 
-.. emacscmd:: notmuch-poll
+.. el:define-key:: M-x notmuch-poll
 
    |docstring::notmuch-poll|
 
-- 
2.35.2

  parent reply	other threads:[~2022-07-31 11:33 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 ` [PATCH 4/7] doc/emacs: split index category from label David Bremner
2022-07-31 11:33 ` David Bremner [this message]
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-6-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).