satellite/audit: Improve code comment in reporter (#2838)

This commit is contained in:
Ivan Fraixedes 2019-08-22 14:13:43 +02:00 committed by GitHub
parent 00b2e1a7d7
commit df29699641
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -137,7 +137,9 @@ func (reporter *Reporter) recordAuditFailStatus(ctx context.Context, failedAudit
return nil, nil
}
// recordOfflineStatus updates nodeIDs in overlay with isup=false
// recordOfflineStatus updates nodeIDs in overlay with isup=false. When there
// is any error the function return the list of nodes which haven't been
// recorded.
func (reporter *Reporter) recordOfflineStatus(ctx context.Context, offlineNodeIDs storj.NodeIDList) (failed storj.NodeIDList, err error) {
defer mon.Task()(&ctx)(&err)
var errlist errs.Group