[PATCH 1/2] doc: clean up boolean vs. probabilistic prefixes

[PATCH 1/2] doc: clean up boolean vs. probabilistic prefixes

[Daniel Kahn Gillmor]

sphinx-build emits a minor warning:

[...]doc/man7/notmuch-search-terms.rst:223: WARNING: Block quote ends without a blank line; unexpected unindent.

And the tabular representation of boolean or probabilistic prefixes
currently renders like this when i view it in man:

       ┌───────────────────────────┬────────────────────────────┐
       │Boolean                    │ Probabilistic              │
       └───────────────────────────┴────────────────────────────┘

       │          tag: id:         │           from: to:        │
       │                           │                            │
       │       thread:     folder: │        subject:    attach‐ │
       │       path:               │        ment: mimetype:     │
       └───────────────────────────┴────────────────────────────┘

This isn't just ugly: it's confusing, because it seems to imply that
some of the prefixes in the left-hand column are somehow related to
specific other prefixes in the right-hand column.

The Definition List representation introduced by this patch should be
simpler for readers to understand, and doesn't have the warning.
---
 doc/man7/notmuch-search-terms.rst | 16 ++++++----------
 1 file changed, 6 insertions(+), 10 deletions(-)

diff --git a/doc/man7/notmuch-search-terms.rst b/doc/man7/notmuch-search-terms.rst
index 223031b..d1c1bd9 100644
--- a/doc/man7/notmuch-search-terms.rst
+++ b/doc/man7/notmuch-search-terms.rst
@@ -215,16 +215,12 @@ Boolean and Probabilistic Prefixes
 Xapian (and hence notmuch) prefixes are either **boolean**, supporting
 exact matches like "tag:inbox"  or **probabilistic**, supporting a more flexible **term** based searching. The prefixes currently supported by notmuch are as follows.
 
-+------------------+-----------------------+
-|Boolean           |Probabilistic          |
-+------------------+-----------------------+
-| **tag:** **id:** | **from:** **to:**     |
-|**thread:**       |**subject:**           |
-|**folder:**       |**attachment:**        |
-|**path:**         |**mimetype:**          |
-|                  |                       |
-+------------------+-----------------------+
-
+    
+Boolean
+   **tag:**, **id:**, **thread:**, **folder:**, **path:**
+Probabilistic
+   **from:**, **to:**, **subject:**, **attachment:**, **mimetype:**
+     
 Terms and phrases
 -----------------
 
-- 
2.8.1

[PATCH 2/2] doc: include nomtuch-emacs-mua in documentation ToC

[Daniel Kahn Gillmor]

Without this patch, i'm seeing sphinx-build emit:

 [...]doc/man1/notmuch-emacs-mua.rst:: WARNING: document isn't included in any toctree
---
 doc/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/doc/index.rst b/doc/index.rst
index 3f0e6e6..344606d 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -14,6 +14,7 @@ Contents:
    man1/notmuch-count
    man1/notmuch-dump
    notmuch-emacs
+   man1/notmuch-emacs-mua
    man5/notmuch-hooks
    man1/notmuch-insert
    man1/notmuch-new
-- 
2.8.1

Re: [PATCH 2/2] doc: include nomtuch-emacs-mua in documentation ToC

[David Bremner]

Daniel Kahn Gillmor <dkg@fifthhorseman.net> writes:

> Without this patch, i'm seeing sphinx-build emit:
>
>  [...]doc/man1/notmuch-emacs-mua.rst:: WARNING: document isn't included in any toctree

Pushed. Hopefully Tomi and Jani feel that notmuch-emacs-mua is ready for
public consumption.

d

Re: [PATCH 1/2] doc: clean up boolean vs. probabilistic prefixes

[David Bremner]

Daniel Kahn Gillmor <dkg@fifthhorseman.net> writes:

> sphinx-build emits a minor warning:
>
> [...]doc/man7/notmuch-search-terms.rst:223: WARNING: Block quote ends without a blank line; unexpected unindent.
>

pushed, with some spurious whitespace amended away.

d