add some minor comments

sreya · sreya · commit c274b27a897f · 2022-06-14T20:05:03.000Z
diff --git a/cli/templatepull_test.go b/cli/templatepull_test.go
@@ -10,7 +10,6 @@ import (
 	"github.com/coder/coder/coderd/coderdtest"
 	"github.com/coder/coder/provisioner/echo"
 	"github.com/coder/coder/provisionersdk/proto"
-	"github.com/coder/coder/pty/ptytest"
 )
 
 func TestTemplatePull(t *testing.T) {
@@ -19,6 +18,7 @@ func TestTemplatePull(t *testing.T) {
 	client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerD: true})
 	user := coderdtest.CreateFirstUser(t, client)
 
+	// Create an initial template bundle.
 	templateSource := &echo.Responses{
 		Parse: []*proto.Parse_Response{
 			{
@@ -36,6 +36,8 @@ func TestTemplatePull(t *testing.T) {
 		Provision: echo.ProvisionComplete,
 	}
 
+	// Create an updated template bundle. This will be used to ensure
+	// that templates are correctly returned in order from latest to oldest.
 	templateSource2 := &echo.Responses{
 		Parse: []*proto.Parse_Response{
 			{
@@ -60,20 +62,18 @@ func TestTemplatePull(t *testing.T) {
 	_ = coderdtest.AwaitTemplateVersionJob(t, client, version1.ID)
 	template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version1.ID)
 
+	// Update the template version so that we can assert that templates
+	// are being sorted correctly.
 	_ = coderdtest.UpdateTemplateVersion(t, client, user.OrganizationID, templateSource2, template.ID)
 
 	cmd, root := clitest.New(t, "templates", "pull", template.Name)
 	clitest.SetupConfig(t, client, root)
 
 	buf := &bytes.Buffer{}
-	pty := ptytest.New(t)
 	cmd.SetOut(buf)
 
 	err = cmd.Execute()
 	require.NoError(t, err)
 
-	err = pty.Close()
-	require.NoError(t, err)
-
 	require.True(t, bytes.Equal(expected, buf.Bytes()), "Bytes differ")
 }
