From: David Bremner <david@tethera.net>
To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org
Subject: [PATCH v2] doc/emacs: document a few notmuch-hello customizable variables.
Date: Mon, 16 May 2022 07:46:10 -0300 [thread overview]
Message-ID: <20220516104610.327031-1-david@tethera.net> (raw)
In-Reply-To: <20220408155910.117231-1-david@tethera.net>
A user asked about the thousands separator on IRC, and I had to check
the source.
---
I realized the docstring was getting mangled when auto-translated to
rst, so I did the manual translation.
doc/conf.py | 2 +-
doc/notmuch-emacs.rst | 41 ++++++++++++++++++++++++++++++++++++++++-
2 files changed, 41 insertions(+), 2 deletions(-)
diff --git a/doc/conf.py b/doc/conf.py
index e46e1d4e..fee52b64 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -45,7 +45,7 @@ if tags.has('WITH_EMACS'):
# Hacky reimplementation of include to workaround limitations of
# sphinx-doc
lines = ['.. include:: /../emacs/rstdoc.rsti\n\n'] # in the source tree
- for file in ('notmuch.rsti', 'notmuch-lib.rsti', 'notmuch-show.rsti', 'notmuch-tag.rsti', 'notmuch-tree.rsti'):
+ for file in ('notmuch.rsti', 'notmuch-lib.rsti', 'notmuch-hello.rsti', 'notmuch-show.rsti', 'notmuch-tag.rsti', 'notmuch-tree.rsti'):
lines.extend(open(rsti_dir+'/'+file))
rst_epilog = ''.join(lines)
del lines
diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst
index 67dbfc2b..595f8e2a 100644
--- a/doc/notmuch-emacs.rst
+++ b/doc/notmuch-emacs.rst
@@ -46,8 +46,47 @@ a mouse or by positioning the cursor and pressing ``<return>``
| Customize Notmuch or this page.
You can change the overall appearance of the notmuch-hello screen by
-customizing the variable :index:`notmuch-hello-sections`.
+customizing the variables
+:index:`notmuch-hello-sections`
+ |docstring::notmuch-hello-sections|
+
+:index:`notmuch-hello-thousands-separator`
+ |docstring::notmuch-hello-thousands-separator|
+
+:index:`notmuch-show-logo`
+ |docstring::notmuch-show-logo|
+
+:index:`!notmuch-column-control`
+ Controls the number of columns for saved searches/tags in notmuch view.
+
+ This variable has three potential types of values:
+
+ .. describe:: t
+
+ Automatically calculate the number of columns possible based
+ on the tags to be shown and the window width.
+
+ .. describe:: integer <n>
+
+ A lower bound on the number of characters that will
+ be used to display each column.
+
+ .. describe:: float <f>
+
+ A fraction of the window width that is the lower bound on the
+ number of characters that should be used for each column.
+
+ So:
+
+ - if you would like two columns of tags, set this to 0.5.
+
+ - if you would like a single column of tags, set this to 1.0.
+
+ - if you would like tags to be 30 characters wide, set this to 30.
+
+ - if you don't want to worry about all of this nonsense, leave
+ this set to `t`.
notmuch-hello key bindings
--
2.35.2
next prev parent reply other threads:[~2022-05-16 10:46 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-08 15:59 [PATCH] doc/emacs: document a few notmuch-hello customizable variables David Bremner
2022-05-16 10:46 ` David Bremner [this message]
2022-05-29 10:35 ` [PATCH v2] " 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=20220516104610.327031-1-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).