Re: [PATCH 1/3] Go bindings: clean up the documentation

diff --git a/7d/3ca79b664a3064c55a0fde0c6f4caeea5562f2 b/7d/3ca79b664a3064c55a0fde0c6f4caeea5562f2
new file mode 100644 (file)
index 0000000..0649a1d
--- /dev/null
+++ b/7d/3ca79b664a3064c55a0fde0c6f4caeea5562f2
@@ -0,0 +1,83 @@
+Return-Path: <teythoon@jade-hamburg.de>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id C28D6431FAF\r
+       for <notmuch@notmuchmail.org>; Sat,  2 Mar 2013 10:27:16 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id C8PkF1nD-+Jp for <notmuch@notmuchmail.org>;\r
+       Sat,  2 Mar 2013 10:27:16 -0800 (PST)\r
+Received: from mail.cryptobitch.de (cryptobitch.de [88.198.7.68])\r
+       (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 1F6A9431FAE\r
+       for <notmuch@notmuchmail.org>; Sat,  2 Mar 2013 10:27:16 -0800 (PST)\r
+Received: from mail.jade-hamburg.de (mail.jade-hamburg.de [85.183.11.228])\r
+       (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by mail.cryptobitch.de (Postfix) with ESMTPSA id BF299615D7E\r
+       for <notmuch@notmuchmail.org>; Sat,  2 Mar 2013 19:27:12 +0100 (CET)\r
+Received: by mail.jade-hamburg.de (Postfix, from userid 401)\r
+       id 40416DF2A3; Sat,  2 Mar 2013 19:27:11 +0100 (CET)\r
+Received: from thinkbox.jade-hamburg.de (thinkbox.jadE-Hamburg.de\r
+ [10.1.1.109]) (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))     (No\r
+ client certificate requested) by mail.jade-hamburg.de (Postfix) with ESMTPS\r
+ id 01654DF28B;        Sat,  2 Mar 2013 19:27:09 +0100 (CET)\r
+Received: from teythoon by thinkbox.jade-hamburg.de with local (Exim 4.80)\r
+       (envelope-from <teythoon@thinkbox.jade-hamburg.de>)\r
+       id 1UBr8I-0007kn-Fu; Sat, 02 Mar 2013 19:26:06 +0100\r
+Content-Type: text/plain; charset="utf-8"\r
+MIME-Version: 1.0\r
+Content-Transfer-Encoding: quoted-printable\r
+To: Julius Plenz <julius@plenz.com>,  notmuch@notmuchmail.org\r
+From: Justus Winter <4winter@informatik.uni-hamburg.de>\r
+In-Reply-To: <1362235856-15358-1-git-send-email-julius@plenz.com>\r
+References: <1362235856-15358-1-git-send-email-julius@plenz.com>\r
+Message-ID: <20130302182606.27570.27062@thinkbox.jade-hamburg.de>\r
+User-Agent: alot/0.3.3+\r
+Subject: Re: [PATCH 1/3] Go bindings: clean up the documentation\r
+Date: Sat, 02 Mar 2013 19:26:06 +0100\r
+Cc: Julius Plenz <julius@plenz.com>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://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: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sat, 02 Mar 2013 18:27:16 -0000\r
+\r
+Hi Julius,\r
+\r
+Quoting Julius Plenz (2013-03-02 15:50:54)\r
+> Most of the copy&paste is either misleading or not helpful; remove that, =\r
+and\r
+> add useful comments where it=E2=80=99s helping.\r
+> ---\r
+> [...]\r
+> +// Open an existing notmuch database located at 'path'. By default the\r
+> +// database should be opened for reading only\r
+> +// (NOTMUCH_STATUS_READ_ONLY_DATABASE). In order to write to the\r
+> +// database you need to pass the NOTMUCH_DATABASE_MODE_READ_WRITE\r
+> +// mode.\r
+>  func OpenDatabase(path string, mode DatabaseMode) (*Database, Status) {\r
+\r
+I appreciate your effort, but there are some specific rules for go\r
+docstrings. I think we should try to follow those rules.\r
+\r
+http://golang.org/doc/articles/godoc_documenting_go_code.html\r
+\r
+Cheers,\r
+Justus\r