fix: make iter error handling clearer (#1561)

codyoss · web-flow · commit dc5af4e6a558 · 2024-12-06T17:46:22.000Z
diff --git a/internal/gengapic/example.go b/internal/gengapic/example.go
@@ -333,7 +333,7 @@ func (g *generator) examplePagingAllCall(m *descriptorpb.MethodDescriptorProto)
 
 	p("for resp, err := range c.%s(ctx, req).All() {", m.GetName())
 	p("  if err != nil {")
-	p("    // TODO: Handle error.")
+	p("    // TODO: Handle error and break/return/continue. Iteration will stop after any error.")
 	p("  }")
 	p("  // TODO: Use resp.")
 	p("  _ = resp")
diff --git a/internal/gengapic/testdata/custom_op_example_all.want b/internal/gengapic/testdata/custom_op_example_all.want
@@ -17,7 +17,7 @@ func ExampleFooClient_GetManyThings_all() {
 	}
 	for resp, err := range c.GetManyThings(ctx, req).All() {
 		if err != nil {
-			// TODO: Handle error.
+			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
 		}
 		// TODO: Use resp.
 		_ = resp
diff --git a/internal/gengapic/testdata/empty_example_all.want b/internal/gengapic/testdata/empty_example_all.want
@@ -17,7 +17,7 @@ func ExampleClient_GetManyThings_all() {
 	}
 	for resp, err := range c.GetManyThings(ctx, req).All() {
 		if err != nil {
-			// TODO: Handle error.
+			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
 		}
 		// TODO: Use resp.
 		_ = resp
@@ -43,7 +43,7 @@ func ExampleClient_ListLocations_all() {
 	}
 	for resp, err := range c.ListLocations(ctx, req).All() {
 		if err != nil {
-			// TODO: Handle error.
+			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
 		}
 		// TODO: Use resp.
 		_ = resp
@@ -69,7 +69,7 @@ func ExampleClient_ListOperations_all() {
 	}
 	for resp, err := range c.ListOperations(ctx, req).All() {
 		if err != nil {
-			// TODO: Handle error.
+			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
 		}
 		// TODO: Use resp.
 		_ = resp
diff --git a/internal/gengapic/testdata/empty_example_grpc_all.want b/internal/gengapic/testdata/empty_example_grpc_all.want
@@ -17,7 +17,7 @@ func ExampleClient_GetManyThings_all() {
 	}
 	for resp, err := range c.GetManyThings(ctx, req).All() {
 		if err != nil {
-			// TODO: Handle error.
+			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
 		}
 		// TODO: Use resp.
 		_ = resp
@@ -43,7 +43,7 @@ func ExampleClient_ListLocations_all() {
 	}
 	for resp, err := range c.ListLocations(ctx, req).All() {
 		if err != nil {
-			// TODO: Handle error.
+			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
 		}
 		// TODO: Use resp.
 		_ = resp
@@ -69,7 +69,7 @@ func ExampleClient_ListOperations_all() {
 	}
 	for resp, err := range c.ListOperations(ctx, req).All() {
 		if err != nil {
-			// TODO: Handle error.
+			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
 		}
 		// TODO: Use resp.
 		_ = resp
diff --git a/internal/gengapic/testdata/foo_example_all.want b/internal/gengapic/testdata/foo_example_all.want
@@ -17,7 +17,7 @@ func ExampleFooClient_GetManyThings_all() {
 	}
 	for resp, err := range c.GetManyThings(ctx, req).All() {
 		if err != nil {
-			// TODO: Handle error.
+			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
 		}
 		// TODO: Use resp.
 		_ = resp
@@ -43,7 +43,7 @@ func ExampleFooClient_ListLocations_all() {
 	}
 	for resp, err := range c.ListLocations(ctx, req).All() {
 		if err != nil {
-			// TODO: Handle error.
+			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
 		}
 		// TODO: Use resp.
 		_ = resp
@@ -69,7 +69,7 @@ func ExampleFooClient_ListOperations_all() {
 	}
 	for resp, err := range c.ListOperations(ctx, req).All() {
 		if err != nil {
-			// TODO: Handle error.
+			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
 		}
 		// TODO: Use resp.
 		_ = resp
diff --git a/internal/gengapic/testdata/foo_example_rest_all.want b/internal/gengapic/testdata/foo_example_rest_all.want
@@ -17,7 +17,7 @@ func ExampleFooClient_GetManyThings_all() {
 	}
 	for resp, err := range c.GetManyThings(ctx, req).All() {
 		if err != nil {
-			// TODO: Handle error.
+			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
 		}
 		// TODO: Use resp.
 		_ = resp
@@ -43,7 +43,7 @@ func ExampleFooClient_ListLocations_all() {
 	}
 	for resp, err := range c.ListLocations(ctx, req).All() {
 		if err != nil {
-			// TODO: Handle error.
+			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
 		}
 		// TODO: Use resp.
 		_ = resp
@@ -69,7 +69,7 @@ func ExampleFooClient_ListOperations_all() {
 	}
 	for resp, err := range c.ListOperations(ctx, req).All() {
 		if err != nil {
-			// TODO: Handle error.
+			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
 		}
 		// TODO: Use resp.
 		_ = resp

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ func ExampleFooClient_GetManyThings_all() {`
`17`	`17`	`}`
`18`	`18`	`for resp, err := range c.GetManyThings(ctx, req).All() {`
`19`	`19`	`if err != nil {`
`20`		`- // TODO: Handle error.`
	`20`	`+ // TODO: Handle error and break/return/continue. Iteration will stop after any error.`
`21`	`21`	`}`
`22`	`22`	`// TODO: Use resp.`
`23`	`23`	`_ = resp`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ func ExampleClient_GetManyThings_all() {`
`17`	`17`	`}`
`18`	`18`	`for resp, err := range c.GetManyThings(ctx, req).All() {`
`19`	`19`	`if err != nil {`
`20`		`- // TODO: Handle error.`
	`20`	`+ // TODO: Handle error and break/return/continue. Iteration will stop after any error.`
`21`	`21`	`}`
`22`	`22`	`// TODO: Use resp.`
`23`	`23`	`_ = resp`
`@@ -43,7 +43,7 @@ func ExampleClient_ListLocations_all() {`
`43`	`43`	`}`
`44`	`44`	`for resp, err := range c.ListLocations(ctx, req).All() {`
`45`	`45`	`if err != nil {`
`46`		`- // TODO: Handle error.`
	`46`	`+ // TODO: Handle error and break/return/continue. Iteration will stop after any error.`
`47`	`47`	`}`
`48`	`48`	`// TODO: Use resp.`
`49`	`49`	`_ = resp`
`@@ -69,7 +69,7 @@ func ExampleClient_ListOperations_all() {`
`69`	`69`	`}`
`70`	`70`	`for resp, err := range c.ListOperations(ctx, req).All() {`
`71`	`71`	`if err != nil {`
`72`		`- // TODO: Handle error.`
	`72`	`+ // TODO: Handle error and break/return/continue. Iteration will stop after any error.`
`73`	`73`	`}`
`74`	`74`	`// TODO: Use resp.`
`75`	`75`	`_ = resp`