[PATCH 1/2] doc: clean up boolean vs. probabilistic prefixes
Daniel Kahn Gillmor
dkg at fifthhorseman.net
Thu Jun 2 09:01:27 PDT 2016
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
More information about the notmuch
mailing list