chore: fix typos and correct variable names

matifali · matifali · commit c0b2cf444864 · 2024-11-05T10:51:46.000+05:00
Several typos in comments and variable names were corrected for accuracy
and clarity. This change helps maintain code readability and correctness.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -667,7 +667,7 @@ jobs:
           # Prevent excessive build runs on minor version changes
           skip: "@(renovate/**|dependabot/**)"
           # Run TurboSnap to trace file dependencies to related stories
-          # and tell chromatic to only take snapshots of relevent stories
+          # and tell chromatic to only take snapshots of relevant stories
           onlyChanged: true
           # Avoid uploading single files, because that's very slow
           zip: true
@@ -694,7 +694,7 @@ jobs:
           workingDir: "./site"
           storybookBaseDir: "./site"
           # Run TurboSnap to trace file dependencies to related stories
-          # and tell chromatic to only take snapshots of relevent stories
+          # and tell chromatic to only take snapshots of relevant stories
           onlyChanged: true
           # Avoid uploading single files, because that's very slow
           zip: true
diff --git a/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go
@@ -941,7 +941,7 @@ func minTime(t, u time.Time) time.Time {
 	return u
 }
 
-func provisonerJobStatus(j database.ProvisionerJob) database.ProvisionerJobStatus {
+func provisionerJobStatus(j database.ProvisionerJob) database.ProvisionerJobStatus {
 	if isNotNull(j.CompletedAt) {
 		if j.Error.String != "" {
 			return database.ProvisionerJobStatusFailed
@@ -1202,7 +1202,7 @@ func (q *FakeQuerier) AcquireProvisionerJob(_ context.Context, arg database.Acqu
 		provisionerJob.StartedAt = arg.StartedAt
 		provisionerJob.UpdatedAt = arg.StartedAt.Time
 		provisionerJob.WorkerID = arg.WorkerID
-		provisionerJob.JobStatus = provisonerJobStatus(provisionerJob)
+		provisionerJob.JobStatus = provisionerJobStatus(provisionerJob)
 		q.provisionerJobs[index] = provisionerJob
 		// clone the Tags before returning, since maps are reference types and
 		// we don't want the caller to be able to mutate the map we have inside
@@ -7456,7 +7456,7 @@ func (q *FakeQuerier) InsertProvisionerJob(_ context.Context, arg database.Inser
 		Tags:           maps.Clone(arg.Tags),
 		TraceMetadata:  arg.TraceMetadata,
 	}
-	job.JobStatus = provisonerJobStatus(job)
+	job.JobStatus = provisionerJobStatus(job)
 	q.provisionerJobs = append(q.provisionerJobs, job)
 	return job, nil
 }
@@ -8842,7 +8842,7 @@ func (q *FakeQuerier) UpdateProvisionerJobByID(_ context.Context, arg database.U
 			continue
 		}
 		job.UpdatedAt = arg.UpdatedAt
-		job.JobStatus = provisonerJobStatus(job)
+		job.JobStatus = provisionerJobStatus(job)
 		q.provisionerJobs[index] = job
 		return nil
 	}
@@ -8863,7 +8863,7 @@ func (q *FakeQuerier) UpdateProvisionerJobWithCancelByID(_ context.Context, arg
 		}
 		job.CanceledAt = arg.CanceledAt
 		job.CompletedAt = arg.CompletedAt
-		job.JobStatus = provisonerJobStatus(job)
+		job.JobStatus = provisionerJobStatus(job)
 		q.provisionerJobs[index] = job
 		return nil
 	}
@@ -8886,7 +8886,7 @@ func (q *FakeQuerier) UpdateProvisionerJobWithCompleteByID(_ context.Context, ar
 		job.CompletedAt = arg.CompletedAt
 		job.Error = arg.Error
 		job.ErrorCode = arg.ErrorCode
-		job.JobStatus = provisonerJobStatus(job)
+		job.JobStatus = provisionerJobStatus(job)
 		q.provisionerJobs[index] = job
 		return nil
 	}
diff --git a/coderd/httpmw/clitelemetry.go b/coderd/httpmw/clitelemetry.go
@@ -46,7 +46,7 @@ func ReportCLITelemetry(log slog.Logger, rep telemetry.Reporter) func(http.Handl
 				return
 			}
 
-			byt, err := base64.StdEncoding.DecodeString(payload)
+			byte, err := base64.StdEncoding.DecodeString(payload)
 			if err != nil {
 				log.Error(
 					r.Context(),
@@ -57,7 +57,7 @@ func ReportCLITelemetry(log slog.Logger, rep telemetry.Reporter) func(http.Handl
 			}
 
 			var inv clitelemetry.Invocation
-			err = json.Unmarshal(byt, &inv)
+			err = json.Unmarshal(byte, &inv)
 			if err != nil {
 				log.Error(
 					r.Context(),
diff --git a/coderd/httpmw/workspaceproxy.go b/coderd/httpmw/workspaceproxy.go
@@ -148,7 +148,7 @@ func ExtractWorkspaceProxy(opts ExtractWorkspaceProxyConfig) func(http.Handler)
 
 type workspaceProxyParamContextKey struct{}
 
-// WorkspaceProxyParam returns the worksace proxy from the ExtractWorkspaceProxyParam handler.
+// WorkspaceProxyParam returns the workspace proxy from the ExtractWorkspaceProxyParam handler.
 func WorkspaceProxyParam(r *http.Request) database.WorkspaceProxy {
 	user, ok := r.Context().Value(workspaceProxyParamContextKey{}).(database.WorkspaceProxy)
 	if !ok {
diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -1023,13 +1023,13 @@ func (api *API) watchWorkspaceAgentMetadata(rw http.ResponseWriter, r *http.Requ
 	// Send metadata on updates, we must ensure subscription before sending
 	// initial metadata to guarantee that events in-between are not missed.
 	update := make(chan agentapi.WorkspaceAgentMetadataChannelPayload, 1)
-	cancelSub, err := api.Pubsub.Subscribe(agentapi.WatchWorkspaceAgentMetadataChannel(workspaceAgent.ID), func(_ context.Context, byt []byte) {
+	cancelSub, err := api.Pubsub.Subscribe(agentapi.WatchWorkspaceAgentMetadataChannel(workspaceAgent.ID), func(_ context.Context, byte []byte) {
 		if ctx.Err() != nil {
 			return
 		}
 
 		var payload agentapi.WorkspaceAgentMetadataChannelPayload
-		err := json.Unmarshal(byt, &payload)
+		err := json.Unmarshal(byte, &payload)
 		if err != nil {
 			log.Error(ctx, "failed to unmarshal pubsub message", slog.Error(err))
 			return
diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -2887,11 +2887,11 @@ func (c *DeploymentValues) WithoutSecrets() (*DeploymentValues, error) {
 	var ff DeploymentValues
 
 	// Create copy via JSON.
-	byt, err := json.Marshal(c)
+	byte, err := json.Marshal(c)
 	if err != nil {
 		return nil, err
 	}
-	err = json.Unmarshal(byt, &ff)
+	err = json.Unmarshal(byte, &ff)
 	if err != nil {
 		return nil, err
 	}

Original file line number	Diff line number	Diff line change
`@@ -2887,11 +2887,11 @@ func (c DeploymentValues) WithoutSecrets() (DeploymentValues, error) {`
`2887`	`2887`	`var ff DeploymentValues`
`2888`	`2888`
`2889`	`2889`	`// Create copy via JSON.`
`2890`		`- byt, err := json.Marshal(c)`
	`2890`	`+ byte, err := json.Marshal(c)`
`2891`	`2891`	`if err != nil {`
`2892`	`2892`	`return nil, err`
`2893`	`2893`	`}`
`2894`		`- err = json.Unmarshal(byt, &ff)`
	`2894`	`+ err = json.Unmarshal(byte, &ff)`
`2895`	`2895`	`if err != nil {`
`2896`	`2896`	`return nil, err`
`2897`	`2897`	`}`