stakey/vspd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

vspd: Improve comment for update func.

Browse Source 
A good comment explains what a function does, not when it is called.
This commit is contained in:
jholdstock 2023-09-26 09:58:38 +01:00 committed by Jamie Holdstock
parent f8bd606468
commit 4012b098fe
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
internal/vspd/update.go
View File

@ -14,8 +14,9 @@ import (
"github.com/jrick/wsrpc/v2"
)
// update is called once when vspd starts up, and once each time a
// blockconnected notification is received from dcrd.
// update uses the latest available information from dcrd to update all of the
// data in the vspd database. When appropriate it will also broadcast pending
// fee transactions and add tickets to voting wallets.
func (v *Vspd) update(ctx context.Context) {
const funcName = "update"
@ -44,7 +45,8 @@ func (v *Vspd) update(ctx context.Context) {
return
}
// Step 4/4: Set ticket outcome in database if any tickets are voted/revoked.
// Step 4/4: Set ticket outcome in database if any tickets are
// voted/revoked.
v.setOutcomes(ctx, dcrdClient)
if ctx.Err() != nil {
return