debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-22 02:48:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: clean up boolean vs. probabilistic prefixes

Browse source 
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.
This commit is contained in:
Daniel Kahn Gillmor 2016-06-02 12:01:27 -04:00 committed by David Bremner
parent d9d2d535b3
commit d080b4100a
1 changed files with 5 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/man7/notmuch-search-terms.rst
View file

@ -215,15 +215,11 @@ Boolean and Probabilistic Prefixes
Xapian (and hence notmuch) prefixes are either **boolean**, supporting 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. 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 | Boolean
+------------------+-----------------------+ **tag:**, **id:**, **thread:**, **folder:**, **path:**
| **tag:** **id:** | **from:** **to:** | Probabilistic
|**thread:** |**subject:** | **from:**, **to:**, **subject:**, **attachment:**, **mimetype:**
|**folder:** |**attachment:** |
|**path:** |**mimetype:** |
| | |
+------------------+-----------------------+
Terms and phrases Terms and phrases
----------------- -----------------