From e557e74cc235a3f948ee8419807b936201d6e52e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Robert=20Paj=C4=85k?= <pellared@hotmail.com>
Date: Wed, 26 Jul 2023 12:14:44 +0200
Subject: [PATCH] Improve readers Collect docs (#4361)

---
 sdk/metric/manual_reader.go        |  4 ++--
 sdk/metric/manual_reader_test.go   | 24 +++++++++---------------
 sdk/metric/periodic_reader.go      |  4 ++--
 sdk/metric/periodic_reader_test.go | 24 +++++++++---------------
 4 files changed, 22 insertions(+), 34 deletions(-)

diff --git a/sdk/metric/manual_reader.go b/sdk/metric/manual_reader.go
index b8dcf1fccda..898af86edc0 100644
--- a/sdk/metric/manual_reader.go
+++ b/sdk/metric/manual_reader.go
@@ -118,8 +118,8 @@ func (mr *ManualReader) Shutdown(context.Context) error {
 	return err
 }
 
-// Collect gathers all metrics from the SDK and other Producers, calling any
-// callbacks necessary and stores the result in rm.
+// Collect gathers all metric data related to the Reader from
+// the SDK and other Producers and stores the result in rm.
 //
 // Collect will return an error if called after shutdown.
 // Collect will return an error if rm is a nil ResourceMetrics.
diff --git a/sdk/metric/manual_reader_test.go b/sdk/metric/manual_reader_test.go
index 485c1b6eaf0..1c2f63cf504 100644
--- a/sdk/metric/manual_reader_test.go
+++ b/sdk/metric/manual_reader_test.go
@@ -80,25 +80,18 @@ func TestManualReaderCollect(t *testing.T) {
 	defer cancel()
 
 	tests := []struct {
-		name string
-
-		ctx             context.Context
-		resourceMetrics *metricdata.ResourceMetrics
-
+		name        string
+		ctx         context.Context
 		expectedErr error
 	}{
 		{
-			name: "with a valid context",
-
-			ctx:             context.Background(),
-			resourceMetrics: &metricdata.ResourceMetrics{},
+			name:        "with a valid context",
+			ctx:         context.Background(),
+			expectedErr: nil,
 		},
 		{
-			name: "with an expired context",
-
-			ctx:             expiredCtx,
-			resourceMetrics: &metricdata.ResourceMetrics{},
-
+			name:        "with an expired context",
+			ctx:         expiredCtx,
 			expectedErr: context.DeadlineExceeded,
 		},
 	}
@@ -117,7 +110,8 @@ func TestManualReaderCollect(t *testing.T) {
 			}, testM)
 			assert.NoError(t, err)
 
-			assert.Equal(t, tt.expectedErr, rdr.Collect(tt.ctx, tt.resourceMetrics))
+			rm := &metricdata.ResourceMetrics{}
+			assert.Equal(t, tt.expectedErr, rdr.Collect(tt.ctx, rm))
 		})
 	}
 }
diff --git a/sdk/metric/periodic_reader.go b/sdk/metric/periodic_reader.go
index 48bbdffd82f..e04c1edbe18 100644
--- a/sdk/metric/periodic_reader.go
+++ b/sdk/metric/periodic_reader.go
@@ -237,8 +237,8 @@ func (r *PeriodicReader) collectAndExport(ctx context.Context) error {
 	return err
 }
 
-// Collect gathers and returns all metric data related to the Reader from
-// the SDK and other Producers and stores the result in rm. The returned metric
+// Collect gathers all metric data related to the Reader from
+// the SDK and other Producers and stores the result in rm. The metric
 // data is not exported to the configured exporter, it is left to the caller to
 // handle that if desired.
 //
diff --git a/sdk/metric/periodic_reader_test.go b/sdk/metric/periodic_reader_test.go
index ad8b5598756..e5b279ec238 100644
--- a/sdk/metric/periodic_reader_test.go
+++ b/sdk/metric/periodic_reader_test.go
@@ -424,25 +424,18 @@ func TestPeriodicReaderCollect(t *testing.T) {
 	defer cancel()
 
 	tests := []struct {
-		name string
-
-		ctx             context.Context
-		resourceMetrics *metricdata.ResourceMetrics
-
+		name        string
+		ctx         context.Context
 		expectedErr error
 	}{
 		{
-			name: "with a valid context",
-
-			ctx:             context.Background(),
-			resourceMetrics: &metricdata.ResourceMetrics{},
+			name:        "with a valid context",
+			ctx:         context.Background(),
+			expectedErr: nil,
 		},
 		{
-			name: "with an expired context",
-
-			ctx:             expiredCtx,
-			resourceMetrics: &metricdata.ResourceMetrics{},
-
+			name:        "with an expired context",
+			ctx:         expiredCtx,
 			expectedErr: context.DeadlineExceeded,
 		},
 	}
@@ -461,7 +454,8 @@ func TestPeriodicReaderCollect(t *testing.T) {
 			}, testM)
 			assert.NoError(t, err)
 
-			assert.Equal(t, tt.expectedErr, rdr.Collect(tt.ctx, tt.resourceMetrics))
+			rm := &metricdata.ResourceMetrics{}
+			assert.Equal(t, tt.expectedErr, rdr.Collect(tt.ctx, rm))
 		})
 	}
 }