1 Return-Path: <teythoon@jade-hamburg.de>
\r
2 X-Original-To: notmuch@notmuchmail.org
\r
3 Delivered-To: notmuch@notmuchmail.org
\r
4 Received: from localhost (localhost [127.0.0.1])
\r
5 by olra.theworths.org (Postfix) with ESMTP id C28D6431FAF
\r
6 for <notmuch@notmuchmail.org>; Sat, 2 Mar 2013 10:27:16 -0800 (PST)
\r
7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
\r
11 X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]
\r
13 Received: from olra.theworths.org ([127.0.0.1])
\r
14 by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)
\r
15 with ESMTP id C8PkF1nD-+Jp for <notmuch@notmuchmail.org>;
\r
16 Sat, 2 Mar 2013 10:27:16 -0800 (PST)
\r
17 Received: from mail.cryptobitch.de (cryptobitch.de [88.198.7.68])
\r
18 (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits))
\r
19 (No client certificate requested)
\r
20 by olra.theworths.org (Postfix) with ESMTPS id 1F6A9431FAE
\r
21 for <notmuch@notmuchmail.org>; Sat, 2 Mar 2013 10:27:16 -0800 (PST)
\r
22 Received: from mail.jade-hamburg.de (mail.jade-hamburg.de [85.183.11.228])
\r
23 (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits))
\r
24 (No client certificate requested)
\r
25 by mail.cryptobitch.de (Postfix) with ESMTPSA id BF299615D7E
\r
26 for <notmuch@notmuchmail.org>; Sat, 2 Mar 2013 19:27:12 +0100 (CET)
\r
27 Received: by mail.jade-hamburg.de (Postfix, from userid 401)
\r
28 id 40416DF2A3; Sat, 2 Mar 2013 19:27:11 +0100 (CET)
\r
29 Received: from thinkbox.jade-hamburg.de (thinkbox.jadE-Hamburg.de
\r
30 [10.1.1.109]) (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits)) (No
\r
31 client certificate requested) by mail.jade-hamburg.de (Postfix) with ESMTPS
\r
32 id 01654DF28B; Sat, 2 Mar 2013 19:27:09 +0100 (CET)
\r
33 Received: from teythoon by thinkbox.jade-hamburg.de with local (Exim 4.80)
\r
34 (envelope-from <teythoon@thinkbox.jade-hamburg.de>)
\r
35 id 1UBr8I-0007kn-Fu; Sat, 02 Mar 2013 19:26:06 +0100
\r
36 Content-Type: text/plain; charset="utf-8"
\r
38 Content-Transfer-Encoding: quoted-printable
\r
39 To: Julius Plenz <julius@plenz.com>, notmuch@notmuchmail.org
\r
40 From: Justus Winter <4winter@informatik.uni-hamburg.de>
\r
41 In-Reply-To: <1362235856-15358-1-git-send-email-julius@plenz.com>
\r
42 References: <1362235856-15358-1-git-send-email-julius@plenz.com>
\r
43 Message-ID: <20130302182606.27570.27062@thinkbox.jade-hamburg.de>
\r
44 User-Agent: alot/0.3.3+
\r
45 Subject: Re: [PATCH 1/3] Go bindings: clean up the documentation
\r
46 Date: Sat, 02 Mar 2013 19:26:06 +0100
\r
47 Cc: Julius Plenz <julius@plenz.com>
\r
48 X-BeenThere: notmuch@notmuchmail.org
\r
49 X-Mailman-Version: 2.1.13
\r
51 List-Id: "Use and development of the notmuch mail system."
\r
52 <notmuch.notmuchmail.org>
\r
53 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,
\r
54 <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
\r
55 List-Archive: <http://notmuchmail.org/pipermail/notmuch>
\r
56 List-Post: <mailto:notmuch@notmuchmail.org>
\r
57 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
\r
58 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,
\r
59 <mailto:notmuch-request@notmuchmail.org?subject=subscribe>
\r
60 X-List-Received-Date: Sat, 02 Mar 2013 18:27:16 -0000
\r
64 Quoting Julius Plenz (2013-03-02 15:50:54)
\r
65 > Most of the copy&paste is either misleading or not helpful; remove that, =
\r
67 > add useful comments where it=E2=80=99s helping.
\r
70 > +// Open an existing notmuch database located at 'path'. By default the
\r
71 > +// database should be opened for reading only
\r
72 > +// (NOTMUCH_STATUS_READ_ONLY_DATABASE). In order to write to the
\r
73 > +// database you need to pass the NOTMUCH_DATABASE_MODE_READ_WRITE
\r
75 > func OpenDatabase(path string, mode DatabaseMode) (*Database, Status) {
\r
77 I appreciate your effort, but there are some specific rules for go
\r
78 docstrings. I think we should try to follow those rules.
\r
80 http://golang.org/doc/articles/godoc_documenting_go_code.html
\r