Skip to content

Commit 4a7cf21

Browse files
committed
docs(internal): add comments
1 parent 0fb2c69 commit 4a7cf21

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

Diff for: internal/testutils/testutils.go

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ package testutils
22

33
import "os"
44

5+
// MustExtractAPITokenFromEnv is a helper function that looks up PAPERSWITHCODE_API_TOKEN.
6+
// It panics if not found.
57
func MustExtractAPITokenFromEnv() string {
68
apiToken, ok := os.LookupEnv("PAPERSWITHCODE_API_TOKEN")
79

Diff for: internal/transport/transport.go

+2
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@ type transportWithAuthHeader struct {
99

1010
var _ http.RoundTripper = transportWithAuthHeader{}
1111

12+
// RoundTrip attaches "Authorization: Token <token>" for every request.
1213
func (t transportWithAuthHeader) RoundTrip(request *http.Request) (*http.Response, error) {
1314
request.Header.Set("Authorization", "Token "+t.token)
1415
return t.r.RoundTrip(request)
1516
}
1617

18+
// NewTransportWithAuthHeader returns middleware that attaches "Authorization: Token <token>" header to every request.
1719
func NewTransportWithAuthHeader(token string) http.RoundTripper {
1820
return transportWithAuthHeader{
1921
r: http.DefaultTransport,

0 commit comments

Comments
 (0)