Skip to content

Commit 3ce4823

Browse files
authored
docs(conflict): Document what a Tango client adapter own
1 parent fcd75e8 commit 3ce4823

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

‎submitqueue/extension/conflict/tango/request.go‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,13 @@ type ChangedTargetsRequest struct {
3434

3535
// ChangedTargetsClient returns the targets a request affects. An adapter owns
3636
// the Tango client and its stream, collects the response, and resolves each
37-
// target's label; any failure to produce a complete answer is an error.
37+
// target's label; any failure to produce a complete answer is an error. It also
38+
// owns the Tango repository remote and computation strategy, which the request
39+
// does not carry. ChangeURIs are passed through as given, so a URI scheme Tango
40+
// does not support is an error.
3841
type ChangedTargetsClient interface {
39-
// ChangedTargets returns one entry per affected target, in no particular
40-
// order. An empty result is valid and means nothing is affected.
42+
// ChangedTargets returns the affected targets in no particular order, and a
43+
// label may repeat. An empty result is valid and means nothing is affected.
4144
ChangedTargets(ctx context.Context, request ChangedTargetsRequest) ([]LabelDistance, error)
4245
}
4346

0 commit comments

Comments
 (0)