Add some comments

Emyrk · Emyrk · commit 73c9928c77de · 2024-07-19T15:32:48.000-05:00
diff --git a/coderd/audit/request.go b/coderd/audit/request.go
@@ -274,10 +274,13 @@ func InitRequestWithCancel[T Auditable](w http.ResponseWriter, p *RequestParams)
 	req, commitF := InitRequest[T](w, p)
 	cancelled := false
 	return req, func(commit bool) {
+		// Once 'commit=false' is called, block
+		// any future commit attempts.
 		if !commit {
 			cancelled = true
 			return
 		}
+		// If it was ever cancelled, block any commits
 		if !cancelled {
 			commitF()
 		}

Original file line number	Diff line number	Diff line change
`@@ -274,10 +274,13 @@ func InitRequestWithCancel[T Auditable](w http.ResponseWriter, p *RequestParams)`
`274`	`274`	`req, commitF := InitRequest[T](w, p)`
`275`	`275`	`cancelled := false`
`276`	`276`	`return req, func(commit bool) {`
	`277`	`+ // Once 'commit=false' is called, block`
	`278`	`+ // any future commit attempts.`
`277`	`279`	`if !commit {`
`278`	`280`	`cancelled = true`
`279`	`281`	`return`
`280`	`282`	`}`
	`283`	`+ // If it was ever cancelled, block any commits`
`281`	`284`	`if !cancelled {`
`282`	`285`	`commitF()`
`283`	`286`	`}`