Skip to content

Commit

Permalink
chore: improve DownloadReleaseAsset documentation
Browse files Browse the repository at this point in the history
This improves `RepositoriesService.DownloadReleaseAsset` documentation
to be a bit more specific and accurate, as per: #3081 (comment)

Signed-off-by: Mike Ball <mikedball@gmail.com>
  • Loading branch information
mdb committed Dec 17, 2024
1 parent cd05a32 commit 94578ef
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions github/repos_releases.go
Original file line number Diff line number Diff line change
Expand Up @@ -333,9 +333,10 @@ func (s *RepositoriesService) GetReleaseAsset(ctx context.Context, owner, repo s
// of the io.ReadCloser. Exactly one of rc and redirectURL will be zero.
//
// followRedirectsClient can be passed to download the asset from a redirected
// location. Passing http.DefaultClient is recommended unless special circumstances
// exist, but it's possible to pass any http.Client. If nil is passed the
// redirectURL will be returned instead.
// location. Specifying any http.Client is possible, but passing http.DefaultClient
// is recommended, except when the specified repository is private, in which case
// it's necessary to pass an http.Client that performs authenticated requests.
// If nil is passed the redirectURL will be returned instead.
//
// GitHub API docs: https://docs.github.com/rest/releases/assets#get-a-release-asset
//
Expand Down

0 comments on commit 94578ef

Please sign in to comment.