Hacker News Reader

Comment by afhof | Hacker News Reader

Its nice to see my name in the Contributors file. I found that submitting patches was easy and said patches were quickly reviewed.

What isn't easy is reading and understanding the documentation. The jump between the Go tour and the Go docs is gaping. I wish some five star technical writers would take a look and fix it since I feel that is Go's biggest problem right now.

View on HN

Between The Go tour and the Go reference does is the Effective Go guide. It gets you going pretty well with lots of practical examples and patterns of how to do things in Go.

http://golang.org/doc/effective_go.html

Really? I feel pretty much the exact opposite way. I find the docs to be thorough, accurate, and concise.

I wish the docs included basic examples of how to use various packages and functions. I end up searching for golang packageX example instead. And often I end up on StackOverflow where someone else is using it wrong and ten others are trying to correct them.

http://gobyexample.com

I completely agree, but only after a good read of Effective Go and honestly the language spec. The language spec is documented and completely, completely readable. I have no doubt it's a result of the simplicity driven by the simple/fast compiler. Just seeing the examples get you in the Go states of mind and prepare you for the standard library.

I do think that sometimes the more complex packages are aided by examples and I think the std lib could take on a few more examples. Fortunately, http://gobyexample.com someone is already doing that.

Reply on news.ycombinator.com