* [PATCH] doc/emacs: document a few notmuch-hello customizable variables.
@ 2022-04-08 15:59 David Bremner
2022-05-16 10:46 ` [PATCH v2] " David Bremner
0 siblings, 1 reply; 3+ messages in thread
From: David Bremner @ 2022-04-08 15:59 UTC (permalink / raw)
To: notmuch
A user asked about the thousands separator on IRC, and I had to check
the source.
---
doc/conf.py | 2 +-
doc/notmuch-emacs.rst | 12 +++++++++++-
2 files changed, 12 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 41f62390..346d0342 100644
--- a/doc/notmuch-emacs.rst
+++ b/doc/notmuch-emacs.rst
@@ -46,9 +46,19 @@ 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`
+ |docstring::notmuch-column-control|
notmuch-hello key bindings
--------------------------
--
2.35.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* [PATCH v2] doc/emacs: document a few notmuch-hello customizable variables.
2022-04-08 15:59 [PATCH] doc/emacs: document a few notmuch-hello customizable variables David Bremner
@ 2022-05-16 10:46 ` David Bremner
2022-05-29 10:35 ` David Bremner
0 siblings, 1 reply; 3+ messages in thread
From: David Bremner @ 2022-05-16 10:46 UTC (permalink / raw)
To: David Bremner, notmuch
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
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v2] doc/emacs: document a few notmuch-hello customizable variables.
2022-05-16 10:46 ` [PATCH v2] " David Bremner
@ 2022-05-29 10:35 ` David Bremner
0 siblings, 0 replies; 3+ messages in thread
From: David Bremner @ 2022-05-29 10:35 UTC (permalink / raw)
To: notmuch
David Bremner <david@tethera.net> writes:
> 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.
Applied to master. The bolding looks a bit garish compared to the plain
variable names, but let's not let perfect be the enemy of better.
d
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-05-29 10:36 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-04-08 15:59 [PATCH] doc/emacs: document a few notmuch-hello customizable variables David Bremner
2022-05-16 10:46 ` [PATCH v2] " David Bremner
2022-05-29 10:35 ` David Bremner
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).