]> rtime.felk.cvut.cz Git - notmuch.git/commit
doc: clean up boolean vs. probabilistic prefixes
authorDaniel Kahn Gillmor <dkg@fifthhorseman.net>
Thu, 2 Jun 2016 16:01:27 +0000 (12:01 -0400)
committerDavid Bremner <david@tethera.net>
Tue, 7 Jun 2016 11:00:40 +0000 (08:00 -0300)
commitd080b4100aedbb93a4a4b43f6d07fa2daba101d3
tree2a1053a9d981262de7a544fd0c0f9b415bcd1cb2
parentd9d2d535b376b4eed455b4d5ca864ae00ee0f4a7
doc: clean up boolean vs. probabilistic prefixes

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