[PATCH 1/2] doc: clean up boolean vs. probabilistic prefixes
authorDaniel Kahn Gillmor <dkg@fifthhorseman.net>
Thu, 2 Jun 2016 16:01:27 +0000 (12:01 +2000)
committerW. Trevor King <wking@tremily.us>
Sat, 20 Aug 2016 23:21:55 +0000 (16:21 -0700)
67/a37a03e928c2eb965945db1bc69425d8c8d8cf [new file with mode: 0644]

diff --git a/67/a37a03e928c2eb965945db1bc69425d8c8d8cf b/67/a37a03e928c2eb965945db1bc69425d8c8d8cf
new file mode 100644 (file)
index 0000000..7564c77
--- /dev/null
@@ -0,0 +1,104 @@
+Return-Path: <dkg@fifthhorseman.net>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by arlo.cworth.org (Postfix) with ESMTP id 96BC16DE01D0\r
+ for <notmuch@notmuchmail.org>; Thu,  2 Jun 2016 09:01:38 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at cworth.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.022\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.022 tagged_above=-999 required=5\r
+ tests=[AWL=-0.022] autolearn=disabled\r
+Received: from arlo.cworth.org ([127.0.0.1])\r
+ by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id ExnO7gTS4TWq for <notmuch@notmuchmail.org>;\r
+ Thu,  2 Jun 2016 09:01:29 -0700 (PDT)\r
+Received: from che.mayfirst.org (che.mayfirst.org [162.247.75.118])\r
+ by arlo.cworth.org (Postfix) with ESMTP id BF3906DE00DB\r
+ for <notmuch@notmuchmail.org>; Thu,  2 Jun 2016 09:01:29 -0700 (PDT)\r
+Received: from fifthhorseman.net (unknown [38.109.115.130])\r
+ by che.mayfirst.org (Postfix) with ESMTPSA id 7BAD1F98B\r
+ for <notmuch@notmuchmail.org>; Thu,  2 Jun 2016 12:01:28 -0400 (EDT)\r
+Received: by fifthhorseman.net (Postfix, from userid 1000)\r
+ id 381BB20245; Thu,  2 Jun 2016 12:01:28 -0400 (EDT)\r
+From: Daniel Kahn Gillmor <dkg@fifthhorseman.net>\r
+To: Notmuch Mail <notmuch@notmuchmail.org>\r
+Subject: [PATCH 1/2] doc: clean up boolean vs. probabilistic prefixes\r
+Date: Thu,  2 Jun 2016 12:01:27 -0400\r
+Message-Id: <1464883288-19823-1-git-send-email-dkg@fifthhorseman.net>\r
+X-Mailer: git-send-email 2.8.1\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=UTF-8\r
+Content-Transfer-Encoding: 8bit\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.20\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <https://notmuchmail.org/mailman/options/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch/>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <https://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Thu, 02 Jun 2016 16:01:38 -0000\r
+\r
+sphinx-build emits a minor warning:\r
+\r
+[...]doc/man7/notmuch-search-terms.rst:223: WARNING: Block quote ends without a blank line; unexpected unindent.\r
+\r
+And the tabular representation of boolean or probabilistic prefixes\r
+currently renders like this when i view it in man:\r
+\r
+       ┌───────────────────────────┬────────────────────────────┐\r
+       │Boolean                    │ Probabilistic              │\r
+       └───────────────────────────┴────────────────────────────┘\r
+\r
+       │          tag: id:         │           from: to:        │\r
+       │                           │                            │\r
+       │       thread:     folder: │        subject:    attach‐ │\r
+       │       path:               │        ment: mimetype:     │\r
+       └───────────────────────────┴────────────────────────────┘\r
+\r
+This isn't just ugly: it's confusing, because it seems to imply that\r
+some of the prefixes in the left-hand column are somehow related to\r
+specific other prefixes in the right-hand column.\r
+\r
+The Definition List representation introduced by this patch should be\r
+simpler for readers to understand, and doesn't have the warning.\r
+---\r
+ doc/man7/notmuch-search-terms.rst | 16 ++++++----------\r
+ 1 file changed, 6 insertions(+), 10 deletions(-)\r
+\r
+diff --git a/doc/man7/notmuch-search-terms.rst b/doc/man7/notmuch-search-terms.rst\r
+index 223031b..d1c1bd9 100644\r
+--- a/doc/man7/notmuch-search-terms.rst\r
++++ b/doc/man7/notmuch-search-terms.rst\r
+@@ -215,16 +215,12 @@ Boolean and Probabilistic Prefixes\r
+ Xapian (and hence notmuch) prefixes are either **boolean**, supporting\r
+ exact matches like "tag:inbox"  or **probabilistic**, supporting a more flexible **term** based searching. The prefixes currently supported by notmuch are as follows.\r
\r
+-+------------------+-----------------------+\r
+-|Boolean           |Probabilistic          |\r
+-+------------------+-----------------------+\r
+-| **tag:** **id:** | **from:** **to:**     |\r
+-|**thread:**       |**subject:**           |\r
+-|**folder:**       |**attachment:**        |\r
+-|**path:**         |**mimetype:**          |\r
+-|                  |                       |\r
+-+------------------+-----------------------+\r
+-\r
++    \r
++Boolean\r
++   **tag:**, **id:**, **thread:**, **folder:**, **path:**\r
++Probabilistic\r
++   **from:**, **to:**, **subject:**, **attachment:**, **mimetype:**\r
++     \r
+ Terms and phrases\r
+ -----------------\r
\r
+-- \r
+2.8.1\r
+\r