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

Justus Winter 4winter at informatik.uni-hamburg.de
Sat Mar 2 10:26:06 PST 2013


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’s 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


More information about the notmuch mailing list