From 52d660418eddebe3d0e55d6e0705c48c0f0bcb14 Mon Sep 17 00:00:00 2001 From: sellskin Date: Tue, 1 Jul 2025 10:47:19 +0800 Subject: [PATCH] chore: fix some minor issues in the comments Signed-off-by: sellskin --- README.md | 2 +- github/dependency_graph.go | 2 +- github/doc.go | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f45d3730399..907846821ad 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ The services of a client divide the API into logical chunks and correspond to the structure of the [GitHub API documentation](https://docs.github.com/en/rest). NOTE: Using the [context](https://pkg.go.dev/context) package, one can easily -pass cancelation signals and deadlines to various services of the client for +pass cancellation signals and deadlines to various services of the client for handling a request. In case there is no context available, then `context.Background()` can be used as a starting point. diff --git a/github/dependency_graph.go b/github/dependency_graph.go index b202aafff55..0218c79054f 100644 --- a/github/dependency_graph.go +++ b/github/dependency_graph.go @@ -66,7 +66,7 @@ type SBOMRelationship struct { // Example: "SPDXRef-github-interlynk-io-sbomqs-main-f43c98" SPDXElementID string `json:"spdxElementId"` - // RelatedSpdxElement is the identifier of the related SPDX element. + // RelatedSPDXElement is the identifier of the related SPDX element. // Example: "SPDXRef-golang-github.comspf13-cobra-1.8.1-75c946" RelatedSPDXElement string `json:"relatedSpdxElement"` diff --git a/github/doc.go b/github/doc.go index 844008d57a6..2d7191cc389 100644 --- a/github/doc.go +++ b/github/doc.go @@ -32,7 +32,7 @@ the structure of the GitHub API documentation at https://docs.github.com/rest . NOTE: Using the [context] package, one can easily -pass cancelation signals and deadlines to various services of the client for +pass cancellation signals and deadlines to various services of the client for handling a request. In case there is no context available, then [context.Background] can be used as a starting point.