From: Daniel Kahn Gillmor Date: Thu, 2 Jun 2016 16:01:27 +0000 (+2000) Subject: [PATCH 1/2] doc: clean up boolean vs. probabilistic prefixes X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=5a05548a3ddecf6862eb35fb7d5fa4ded62637b4;p=notmuch-archives.git [PATCH 1/2] doc: clean up boolean vs. probabilistic prefixes --- diff --git a/67/a37a03e928c2eb965945db1bc69425d8c8d8cf b/67/a37a03e928c2eb965945db1bc69425d8c8d8cf new file mode 100644 index 000000000..7564c77dd --- /dev/null +++ b/67/a37a03e928c2eb965945db1bc69425d8c8d8cf @@ -0,0 +1,104 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by arlo.cworth.org (Postfix) with ESMTP id 96BC16DE01D0 + for ; Thu, 2 Jun 2016 09:01:38 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at cworth.org +X-Spam-Flag: NO +X-Spam-Score: -0.022 +X-Spam-Level: +X-Spam-Status: No, score=-0.022 tagged_above=-999 required=5 + tests=[AWL=-0.022] autolearn=disabled +Received: from arlo.cworth.org ([127.0.0.1]) + by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id ExnO7gTS4TWq for ; + Thu, 2 Jun 2016 09:01:29 -0700 (PDT) +Received: from che.mayfirst.org (che.mayfirst.org [162.247.75.118]) + by arlo.cworth.org (Postfix) with ESMTP id BF3906DE00DB + for ; Thu, 2 Jun 2016 09:01:29 -0700 (PDT) +Received: from fifthhorseman.net (unknown [38.109.115.130]) + by che.mayfirst.org (Postfix) with ESMTPSA id 7BAD1F98B + for ; Thu, 2 Jun 2016 12:01:28 -0400 (EDT) +Received: by fifthhorseman.net (Postfix, from userid 1000) + id 381BB20245; Thu, 2 Jun 2016 12:01:28 -0400 (EDT) +From: Daniel Kahn Gillmor +To: Notmuch Mail +Subject: [PATCH 1/2] doc: clean up boolean vs. probabilistic prefixes +Date: Thu, 2 Jun 2016 12:01:27 -0400 +Message-Id: <1464883288-19823-1-git-send-email-dkg@fifthhorseman.net> +X-Mailer: git-send-email 2.8.1 +MIME-Version: 1.0 +Content-Type: text/plain; charset=UTF-8 +Content-Transfer-Encoding: 8bit +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.20 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Thu, 02 Jun 2016 16:01:38 -0000 + +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 +