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