search

gorhill / cronexpr

Cron expression parser in Go language (golang)
683 stars 168 forks source link

Add package comment #2

Closed ghost closed 11 years ago

ghost commented 11 years ago

There's no package-level documentation: http://godoc.org/github.com/gorhill/cronexpression

At a minimum, the package comment should include a first sentence synopsis.

// Package cronexpression parses cron time expressions.
package conexpression

Edit: There's a lot of doc in the readme that should probably pulled into the code so that it's readable in various Go tools.

gorhill commented 11 years ago

Ok, I will address, I need some reading to understand how to create code-embedded doc.

gorhill commented 11 years ago

Done -> d3a85f92d82041b188f5f137e855c3257e7058ee

ghost commented 11 years ago

How to create code-embedded doc: http://golang.org/doc/articles/godoc_documenting_go_code.html

The application at https://github.com/golang/lint#readme will provide feedback on the comments and more.