add . to end of comments

couchbasecloud · Sep 25, 2024 · 6b32b38 · 6b32b38
1 parent 7d7a78a
commit 6b32b38
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 19 deletions.
diff --git a/internal/api/gsi.go b/internal/api/gsi.go
@@ -9,7 +9,7 @@ type IndexDDLRequest struct {
 
 // QueryError is the error message returned by query service.
 type QueryError struct {
-	// Msg The error message
+	// Msg The error message.
 	Msg string `json:"msg"`
 }
 

diff --git a/internal/datasources/gsi.go b/internal/datasources/gsi.go
@@ -80,8 +80,8 @@ func (g *GsiDefinitions) Read(ctx context.Context, req datasource.ReadRequest, r
 		return
 	}
 
-	// data sources don't support Default
-	// https://github.com/hashicorp/terraform-plugin-framework/issues/751
+	// data sources don't support Default.
+	// https://github.com/hashicorp/terraform-plugin-framework/issues/751 .
 	var scope, collection string
 	if config.ScopeName.IsNull() {
 		scope = "_default"

diff --git a/internal/datasources/gsi_monitor.go b/internal/datasources/gsi_monitor.go
@@ -84,8 +84,8 @@ func (g *GsiMonitor) Read(ctx context.Context, req datasource.ReadRequest, resp
 		return
 	}
 
-	// data sources don't support Default
-	// https://github.com/hashicorp/terraform-plugin-framework/issues/751
+	// data sources don't support Default.
+	// https://github.com/hashicorp/terraform-plugin-framework/issues/751 .
 	var scope, collection string
 	if config.ScopeName.IsNull() {
 		scope = "_default"
@@ -112,7 +112,7 @@ func (g *GsiMonitor) Read(ctx context.Context, req datasource.ReadRequest, resp
 
 	cfg := api.EndpointCfg{Url: uri, Method: http.MethodGet, SuccessStatus: http.StatusOK}
 
-	// 60 min is arbitrary
+	// 60 min is arbitrary.
 	const timeout = time.Minute * 60
 
 	var cancel context.CancelFunc
@@ -186,7 +186,7 @@ func (g *GsiMonitor) Read(ctx context.Context, req datasource.ReadRequest, resp
 			}
 
 			attempt++
-			// exponential backoff upto a max of 20 min
+			// exponential backoff upto a max of 20 min.
 			d := min(20, 1<<attempt)
 			timer.Reset(time.Duration(d) * time.Minute)
 		}

diff --git a/internal/resources/gsi.go b/internal/resources/gsi.go
@@ -55,7 +55,7 @@ func (g *GSI) Create(ctx context.Context, req resource.CreateRequest, resp *reso
 
 	var ddl string
 
-	// create build index statement
+	// create build index statement.
 	if !plan.BuildIndexes.IsNull() {
 		ddl = fmt.Sprintf(
 			"BUILD INDEX ON `%s`.`%s`.`%s`(%s)",
@@ -65,7 +65,7 @@ func (g *GSI) Create(ctx context.Context, req resource.CreateRequest, resp *reso
 			listStringValues(plan.BuildIndexes),
 		)
 	} else {
-		// create primary index statement
+		// create primary index statement.
 		if plan.IsPrimary.ValueBool() {
 			var indexName string
 			if !plan.IndexName.IsNull() {
@@ -83,7 +83,7 @@ func (g *GSI) Create(ctx context.Context, req resource.CreateRequest, resp *reso
 				plan.With.NumReplica.ValueInt64(),
 			)
 		} else {
-			// create secondary index statement
+			// create secondary index statement.
 			ddl = fmt.Sprintf(
 				"CREATE INDEX `%s` ON `%s`.`%s`.`%s`(%s) ",
 				plan.IndexName.ValueString(),
@@ -111,7 +111,7 @@ func (g *GSI) Create(ctx context.Context, req resource.CreateRequest, resp *reso
 
 				ddl += withClause
 			} else {
-				// should not set num_partition for non-partitioned index
+				// should not set num_partition for non-partitioned index.
 				withClause := fmt.Sprintf(
 					" WITH { \"defer_build\": %t,  \"num_replica\": %d} ",
 					plan.With.DeferBuild.ValueBool(),
@@ -187,11 +187,11 @@ func (g *GSI) Read(ctx context.Context, req resource.ReadRequest, resp *resource
 	}
 
 	if !state.OrganizationId.IsNull() {
-		// when reading an index, only update number of replicas
+		// when reading an index, only update number of replicas.
 		state.With.NumReplica = types.Int64Value(int64(index.NumReplica))
 
 	} else {
-		// when importing index, set all attributes
+		// when importing index, set all attributes.
 		state.OrganizationId = types.StringValue(organizationID)
 		state.ProjectId = types.StringValue(projectID)
 		state.ClusterId = types.StringValue(clusterID)
@@ -216,7 +216,7 @@ func (g *GSI) Read(ctx context.Context, req resource.ReadRequest, resp *resource
 		}
 
 		state.IndexKeys = keyList
-		// TODO:  set partition by
+		// TODO:  set partition by.
 		state.Where = types.StringValue(index.Where)
 		if state.With != nil {
 			state.With.NumReplica = types.Int64Value(int64(index.NumReplica))
@@ -470,7 +470,7 @@ func (g *GSI) getQueryIndex(
 	return &index, nil
 }
 
-// joins a list of strings
+// joins a list of strings.
 func listStringValues(s types.List) string {
 	elements := s.Elements()
 	var str string

diff --git a/internal/schema/gsi.go b/internal/schema/gsi.go
@@ -83,7 +83,7 @@ type GsiData struct {
 	// IndexName is the name of the index.
 	IndexName types.String `tfsdk:"index_name"`
 
-	// Definition is the index definition
+	// Definition is the index definition.
 	Definition types.String `tfsdk:"definition"`
 }
 
@@ -114,7 +114,7 @@ type GsiBuildStatus struct {
 }
 
 func (g *GsiDefinition) GetAttributeValues() (map[Attr]string, error) {
-	// handle terraform import
+	// handle terraform import.
 	if g.OrganizationId.IsNull() {
 		attrs, err := splitImportString(
 			g.IndexName.ValueString(),
@@ -132,7 +132,7 @@ func (g *GsiDefinition) GetAttributeValues() (map[Attr]string, error) {
 		return attrs, nil
 	}
 
-	// handle Read()
+	// handle Read().
 	attrs := map[Attr]string{
 		OrganizationId: g.OrganizationId.ValueString(),
 		ProjectId:      g.ProjectId.ValueString(),
@@ -143,7 +143,7 @@ func (g *GsiDefinition) GetAttributeValues() (map[Attr]string, error) {
 		IndexName:      "",
 	}
 	// if a primary index was created without a name,
-	// indexer uses name #primary
+	// indexer uses name #primary.
 	if !g.IsPrimary.IsNull() && g.IndexName.IsNull() {
 		attrs[IndexName] = "#primary"
 	} else {