comment on exported type PixelGroup should be of the form "PixelGroup ..." (with optional leading article)
6 log "github.com/LedFx/ledfx/pkg/logger"
7)
8
9// A group of device's pixels. Effects render onto a pixel group. 10type PixelGroup struct {
11 Group map[string]color.Pixels // the group of pixels. maps device id to pixels
12 Order []string // defines the order of the pixels in the group
Description
Doc comments work best as complete sentences, which allow a wide variety of automated presentations. The first sentence should be a one-sentence summary that starts with the name being declared.
If every doc comment begins with the name of the item it describes, you can use the doc subcommand of the go tool and run the output through grep.
See https://golang.org/doc/effective_go.html#commentary for more information on how to write good documentation.
Bad practice
package main
// This struct represents an cybernetically enhanced duck
type Duck struct {
}
Recommended
package main
// Duck represents an cybernetically enhanced duck
type Duck struct {
}