Newbrict / engi

Oaktales engi fork
BSD 2-Clause "Simplified" License
0 stars 0 forks source link

Documentation #19

Open paked opened 9 years ago

paked commented 9 years ago

For future reference of ourselves, and the possible benefit of others we need to start documenting things we are adding. I personally think that every new change made in master should have accompanying documentation (in the form of a comment saying what the new function done).

I suggest writing http://godoc.org compatible documentation. (resources on how to do so: http://godoc.org/-/about, http://blog.golang.org/godoc-documenting-go-code)