comment on exported function FindTopoFileByPath should be of the form "FindTopoFileByPath ..."
171 return file, nil
172}
173
174// findTopoFileByPath takes a topology path, which might be the path to a directory175// and returns the topology file name if found.
176func FindTopoFileByPath(path string) (string, error) {
177 finfo, err := os.Stat(path)
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 function tries to summon a cybernetically enhanced duck
func SummonDucks() {
}
Recommended
package main
// SummonDucks tries to summon a cybernetically enhanced duck
func SummonDucks() {
}