瀏覽代碼

Add comment on how `IssueComment` gets unified.

Eric Huss 2 年之前
父節點
當前提交
7e85b631fc
共有 1 個文件被更改,包括 3 次插入0 次删除
  1. 3 0
      src/github.rs

+ 3 - 0
src/github.rs

@@ -1256,6 +1256,9 @@ pub enum Event {
     /// - Regular comment on an issue or PR.
     /// - A PR review.
     /// - A comment on a PR review.
+    ///
+    /// These different scenarios are unified into the `IssueComment` variant
+    /// when triagebot receives the corresponding webhook event.
     IssueComment(IssueCommentEvent),
     /// Activity on an issue or PR.
     Issue(IssuesEvent),