wallclockbuilder / stringutil

Ruby's string manipulation convenience functions for Golang
BSD 2-Clause "Simplified" License
2 stars 1 forks source link

godoc package documentation file doc.go file doesn't exist #36

Closed wallclockbuilder closed 9 years ago

wallclockbuilder commented 9 years ago

The package wide docs are currently located in the chop.go file. Thats inappropriate to put package-wide documentation in a specific module file. It should much more appropriately be located in the file docs.go

wallclockbuilder commented 9 years ago

Please move the package specific documentation to docs.go.

wallclockbuilder commented 9 years ago

Please cite a link that supports the convention that package specific files should be located in the doc.go file. That would be helpful and educational to us all. Otherwise your suggestions remain what they are, personal preferred suggestions. Thanks.

wallclockbuilder commented 9 years ago

Here's the documentation for documenting go packages: godoc documenting go packages

wallclockbuilder commented 9 years ago

Heres the brief version as used by the sort package: sort go source file

wallclockbuilder commented 9 years ago

And heres the detailed version as used by the gob package: beginning doc go file for gob beginning ending doc go file for gob ending

wallclockbuilder commented 9 years ago

So doc.go file please.

wallclockbuilder commented 9 years ago

:+1: