Golint and Godoc issues

[ainar-g]

Both golint and godoc.org show some issues in packages' documentation. The linter mostly complains about "malformed" or missing doc comments, e.g. notify.go:63:1: comment on exported function NewListenerConn should be of the form "NewListenerConn ...". It also complains about package listen_example's name containing an underscore. Godoc is mostly fine, aside from the missing comments, but some code and lists are not aligned to the 80 char mark, and thus the scroll bars appears at https://godoc.org/github.com/lib/pq#pkg-constants. Thus, some proposals:

• Align all code and lists to the 80 char mark.

• Add missing documentation and fix documentation golint complains about.

• Move listen_example to examples/listen.

• Add a link to godoc.org to the README.

Adding golint to the Travis builds is doable, but I am not sure if it's worth it.

Thoughts?

[tamird]

Go for it. Please add golint to Travis.

…

On Sun, Oct 22, 2017 at 5:20 AM, Ainar Garipov ***@***.***> wrote: Both golint and godoc.org show some issues in packages' documentation. The linter mostly complains about "malformed" or missing doc comments, e.g. notify.go:63:1: comment on exported function NewListenerConn should be of the form "NewListenerConn ...". It also complains about package listen_example's name containing an underscore. Godoc is mostly fine, aside from the missing comments, but some code and lists are not aligned to the 80 char mark, and thus the scroll bars appears at https://godoc.org/github.com/ lib/pq#pkg-constants. Thus, some proposals: - Align all code and lists to the 80 char mark. - Add missing documentation and fix documentation golint complains about. - Move listen_example to examples/listen. - Add a link to godoc.org to the README. Adding golint to the Travis builds is doable, but I am not sure if it's worth it. Thoughts? — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#669>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABdsPG96nqiA1Jlpli4AqDhDOtmIsihKks5suwjngaJpZM4QB4N7> .