connmgr: Stale comment in TestRemovePendingConnection

[sloorush]

in TestRemovePendingConnection

btcd/connmgr/connmanager_test.go

Lines 466 to 470 in 3e2d846

	// Now examine the status of the connection request, it should read a
	// status of failed.
	if cr.State() != ConnCanceled {
	t.Fatalf("request wasn't canceled, status is: %v", cr.State())
	}

The comment says that it should read a cr.State() of ConnFailing but it gives a fatal when it is not ConnCanceled ie ConnFailing.

The comment is stale as the test was added here
548c0f4#diff-ed803b6cfd814b3d3d6846a89c2bedd39bd560d7a782b9fb1da42560451dd0a0

and it was changed to check for ConnCanceled here
b26daff#diff-ed803b6cfd814b3d3d6846a89c2bedd39bd560d7a782b9fb1da42560451dd0a
but the comment was not changed

Solution

Changing the comment to

// Now examine the status of the connection request, it should read a 
// status of ConnCanceled.

should resolve the confusion