fix comments

mafredri · mafredri · commit a34e202b1ccd · 2025-04-14T13:56:53.000Z
diff --git a/agent/agentcontainers/api.go b/agent/agentcontainers/api.go
@@ -64,9 +64,9 @@ func WithDevcontainerCLI(dccli DevcontainerCLI) Option {
 	}
 }
 
-// WithDevcontainers sets the known devcontainers and scripts for the
-// API. This allows allows the API to be aware of devcontainers defined
-// in the workspace agent manifest.
+// WithDevcontainers sets the known devcontainers for the API. This
+// allows the API to be aware of devcontainers defined in the workspace
+// agent manifest.
 func WithDevcontainers(devcontainers []codersdk.WorkspaceAgentDevcontainer) Option {
 	return func(api *API) {
 		if len(devcontainers) > 0 {
@@ -195,7 +195,6 @@ func (api *API) getContainers(ctx context.Context) (codersdk.WorkspaceAgentListC
 			}
 
 			// If not in our known list, add as a runtime detected entry.
-			// Parse name from folder
 			name := path.Base(workspaceFolder)
 			if _, ok := api.devcontainerNames[name]; ok {
 				// Try to find a unique name by appending a number.
diff --git a/agent/agentcontainers/api_test.go b/agent/agentcontainers/api_test.go
@@ -188,7 +188,7 @@ func TestAPI(t *testing.T) {
 				ID:              knownDevcontainerID2,
 				Name:            "known-devcontainer-2",
 				WorkspaceFolder: "/workspace/known2",
-				// No config path intentionally
+				// No config path intentionally.
 			},
 		}
 
@@ -293,7 +293,6 @@ func TestAPI(t *testing.T) {
 				wantStatus:         http.StatusOK,
 				wantCount:          3, // 2 known + 1 runtime
 				verify: func(t *testing.T, devcontainers []codersdk.WorkspaceAgentDevcontainer) {
-					// Find and verify devcontainers by workspace folder
 					known1 := mustFindDevcontainerByPath(t, devcontainers, "/workspace/known1")
 					known2 := mustFindDevcontainerByPath(t, devcontainers, "/workspace/known2")
 					runtime1 := mustFindDevcontainerByPath(t, devcontainers, "/workspace/runtime1")
@@ -373,7 +372,6 @@ func TestAPI(t *testing.T) {
 				wantStatus:         http.StatusOK,
 				wantCount:          2,
 				verify: func(t *testing.T, devcontainers []codersdk.WorkspaceAgentDevcontainer) {
-					// Find devcontainer with ID matching knownDevcontainerID2
 					var dc2 *codersdk.WorkspaceAgentDevcontainer
 					for i := range devcontainers {
 						if devcontainers[i].ID == knownDevcontainerID2 {
@@ -484,7 +482,7 @@ func TestAPI(t *testing.T) {
 				// Verify the number of devcontainers in the response.
 				assert.Len(t, response.Devcontainers, tt.wantCount, "wrong number of devcontainers")
 
-				// Run custom verification if provided
+				// Run custom verification if provided.
 				if tt.verify != nil && len(response.Devcontainers) > 0 {
 					tt.verify(t, response.Devcontainers)
 				}

Original file line number	Diff line number	Diff line change
`@@ -64,9 +64,9 @@ func WithDevcontainerCLI(dccli DevcontainerCLI) Option {`
`64`	`64`	`}`
`65`	`65`	`}`
`66`	`66`
`67`		`-// WithDevcontainers sets the known devcontainers and scripts for the`
`68`		`-// API. This allows allows the API to be aware of devcontainers defined`
`69`		`-// in the workspace agent manifest.`
	`67`	`+// WithDevcontainers sets the known devcontainers for the API. This`
	`68`	`+// allows the API to be aware of devcontainers defined in the workspace`
	`69`	`+// agent manifest.`
`70`	`70`	`func WithDevcontainers(devcontainers []codersdk.WorkspaceAgentDevcontainer) Option {`
`71`	`71`	`return func(api *API) {`
`72`	`72`	`if len(devcontainers) > 0 {`
`@@ -195,7 +195,6 @@ func (api *API) getContainers(ctx context.Context) (codersdk.WorkspaceAgentListC`
`195`	`195`	`}`
`196`	`196`
`197`	`197`	`// If not in our known list, add as a runtime detected entry.`
`198`		`- // Parse name from folder`
`199`	`198`	`name := path.Base(workspaceFolder)`
`200`	`199`	`if _, ok := api.devcontainerNames[name]; ok {`
`201`	`200`	`// Try to find a unique name by appending a number.`