Merge pull request cli#10296 from petercover/trunk

williammartin · web-flow · commit 8dc1a969bb4d · 2025-01-22T23:34:24.000+01:00
chore: fix some comments
diff --git a/README.md b/README.md
@@ -129,7 +129,7 @@ Download packaged binaries from the [releases page][].
 
 Since version 2.50.0 `gh` has been producing [Build Provenance Attestation](https://github.blog/changelog/2024-06-25-artifact-attestations-is-generally-available/) enabling a cryptographically verifiable paper-trail back to the origin GitHub repository, git revision and build instructions used. The build provenance attestations are signed and relies on Public Good [Sigstore](https://www.sigstore.dev/) for PKI.
 
-There are two common ways to verify a downloaded release, depending if `gh` is aready installed or not. If `gh` is installed, it's trivial to verify a new release:
+There are two common ways to verify a downloaded release, depending if `gh` is already installed or not. If `gh` is installed, it's trivial to verify a new release:
 
 - **Option 1: Using `gh` if already installed:**
 
diff --git a/pkg/cmd/codespace/ssh_test.go b/pkg/cmd/codespace/ssh_test.go
@@ -124,7 +124,7 @@ func TestGenerateAutomaticSSHKeys(t *testing.T) {
 }
 
 func TestSelectSSHKeys(t *testing.T) {
-	// This string will be subsituted in sshArgs for test cases
+	// This string will be substituted in sshArgs for test cases
 	// This is to work around the temp test ssh dir not being known until the test is executing
 	substituteSSHDir := "SUB_SSH_DIR"
 
diff --git a/pkg/cmd/factory/default.go b/pkg/cmd/factory/default.go
@@ -117,7 +117,7 @@ func BaseRepoFunc(f *cmdutil.Factory) func() (ghrepo.Interface, error) {
 // even more confusion because the API requests can be different, and FURTHERMORE this can be an issue for
 // services that don't handle renames correctly, like the ElasticSearch indexing.
 //
-// Assuming we have an interactive invocation, then the next step is to resolve a network of respositories. This
+// Assuming we have an interactive invocation, then the next step is to resolve a network of repositories. This
 // involves creating a dynamic GQL query requesting information about each repository (up to a limit of 5).
 // Each returned repo is added to a list, along with its parent, if present in the query response.
 // The repositories in the query retain the same ordering as previously outlined. Interestingly, the request is sent
diff --git a/pkg/cmd/run/shared/shared.go b/pkg/cmd/run/shared/shared.go
@@ -275,7 +275,7 @@ var ErrMissingAnnotationsPermissions = errors.New("missing annotations permissio
 
 // GetAnnotations fetches annotations from the REST API.
 //
-// If the job has no annotations, an empy slice is returned.
+// If the job has no annotations, an empty slice is returned.
 // If the API returns a 403, a custom ErrMissingAnnotationsPermissions error is returned.
 //
 // When fine-grained PATs support checks:read permission, we can remove the need for this at the call sites.
diff --git a/pkg/iostreams/iostreams.go b/pkg/iostreams/iostreams.go
@@ -524,7 +524,7 @@ func (w *fdWriteCloser) Fd() uintptr {
 	return w.fd
 }
 
-// fdWriter represents a wrapped stdin ReadCloser that preserves the original file descriptor
+// fdReader represents a wrapped stdin ReadCloser that preserves the original file descriptor
 type fdReader struct {
 	io.ReadCloser
 	fd uintptr

Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ func TestGenerateAutomaticSSHKeys(t *testing.T) {`
`124`	`124`	`}`
`125`	`125`
`126`	`126`	`func TestSelectSSHKeys(t *testing.T) {`
`127`		`- // This string will be subsituted in sshArgs for test cases`
	`127`	`+ // This string will be substituted in sshArgs for test cases`
`128`	`128`	`// This is to work around the temp test ssh dir not being known until the test is executing`
`129`	`129`	`substituteSSHDir := "SUB_SSH_DIR"`
`130`	`130`
Original file line number	Diff line number	Diff line change
`@@ -524,7 +524,7 @@ func (w *fdWriteCloser) Fd() uintptr {`
`524`	`524`	`return w.fd`
`525`	`525`	`}`
`526`	`526`
`527`		`-// fdWriter represents a wrapped stdin ReadCloser that preserves the original file descriptor`
	`527`	`+// fdReader represents a wrapped stdin ReadCloser that preserves the original file descriptor`
`528`	`528`	`type fdReader struct {`
`529`	`529`	`io.ReadCloser`
`530`	`530`	`fd uintptr`