Closed wallclockbuilder closed 9 years ago
Please move the package specific documentation to docs.go.
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.
Here's the documentation for documenting go packages:
Heres the brief version as used by the sort package:
And heres the detailed version as used by the gob package: beginning ending
So doc.go file please.
:+1:
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