Skip to content

Commit 9734fe0

Browse files
committed
Merge pull request github#305 from github/clarify-watchevent
Clarify that WatchEvent is used for starring
2 parents 75d1d01 + cc52aa6 commit 9734fe0

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

content/v3/activity/events/types.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -245,11 +245,14 @@ repo
245245

246246
## WatchEvent
247247

248-
The event's actor is the watcher, and the event's repo is the watched
249-
repository.
248+
The WatchEvent is related to starring a repository, not watching.
249+
See [this API blog post](http://developer.github.com/changes/2012-9-5-watcher-api/)
250+
for an explanation.
251+
252+
The event’s actor is the user who starred a repository, and the event’s repo is
253+
the repository that was starred.
250254

251255
Hook name: `watch`
252256

253257
action
254-
: **string** - The action that was performed.
255-
258+
: **string** - The action that was performed: "started".

0 commit comments

Comments
 (0)