comment on exported function CopyAttestation should be of the form "CopyAttestation ..."
177 SetSignature(sig []byte)
178}
179
180// TODO: this is ugly. The proper way to do this is to create a Copy() function on the interface and implement it. But this results in a circular dependency.181// CopyAttestation copies the provided attestation object.
182func CopyAttestation(att Attestation) Attestation {
183 a, ok := att.(*ethpb.Attestation)comment on exported function CommitteeIndices should be of the form "CommitteeIndices ..."
295 return UnshuffleList(indices, seed)
296}
297
298// TODO: doc299func CommitteeIndices(committeeBits bitfield.Bitlist) []primitives.CommitteeIndex {
300 indices := committeeBits.BitIndices()
301 committeeIndices := make([]primitives.CommitteeIndex, len(indices))
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() {
}