comment on exported function HasETH1WithdrawalCredential should be of the form "HasETH1WithdrawalCredential ..."
497 return lastActivatedvalidatorIndex, nil
498}
499
500// hasETH1WithdrawalCredential returns whether the validator has an ETH1501// Withdrawal prefix. It assumes that the caller has a lock on the state
502func HasETH1WithdrawalCredential(val *ethpb.Validator) bool {
503 if val == nil {
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() {
}