Skip to content

Commit b82aaba

Browse files
committed
Address review feedback
1 parent 2d6e2bb commit b82aaba

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

github/repos_hooks.go

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,27 @@ import (
1111
"time"
1212
)
1313

14-
// Deprecated: Please use PushEvent instead.
1514
// WebHookPayload represents the data that is received from GitHub when a push
1615
// event hook is triggered. The format of these payloads pre-date most of the
1716
// GitHub v3 API, so there are lots of minor incompatibilities with the types
1817
// defined in the rest of the API. Therefore, several types are duplicated
1918
// here to account for these differences.
2019
//
2120
// GitHub API docs: https://help.github.com/articles/post-receive-hooks
21+
//
22+
// Deprecated: Please use PushEvent instead.
2223
type WebHookPayload = PushEvent
2324

24-
// Deprecated: Please use HeadCommit instead.
2525
// WebHookCommit represents the commit variant we receive from GitHub in a
2626
// WebHookPayload.
27+
//
28+
// Deprecated: Please use HeadCommit instead.
2729
type WebHookCommit = HeadCommit
2830

29-
// Deprecated: Please use CommitAuthor instead.
3031
// WebHookAuthor represents the author or committer of a commit, as specified
3132
// in a WebHookCommit. The commit author may not correspond to a GitHub User.
3233
//
34+
// Deprecated: Please use CommitAuthor instead.
3335
// NOTE Breaking API change: the `Username` field is now called `Login`.
3436
type WebHookAuthor = CommitAuthor
3537

0 commit comments

Comments
 (0)