From 2d10cc10be20944a90cd945fe8ad07ce46037938 Mon Sep 17 00:00:00 2001
From: Him188 <Him188@mamoe.net>
Date: Sun, 30 May 2021 09:42:08 +0800
Subject: [PATCH] Add implementation notes for `Listener`
---
mirai-core-api/src/commonMain/kotlin/event/Listener.kt | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/mirai-core-api/src/commonMain/kotlin/event/Listener.kt b/mirai-core-api/src/commonMain/kotlin/event/Listener.kt
index e62dbf299..e01cb2a0a 100644
--- a/mirai-core-api/src/commonMain/kotlin/event/Listener.kt
+++ b/mirai-core-api/src/commonMain/kotlin/event/Listener.kt
@@ -45,6 +45,11 @@ public enum class ListeningStatus {
*/
public interface Listener<in E : Event> : CompletableJob {
+ // Impl notes:
+ // Inheriting CompletableJob is a bad idea. See #1224.
+ // However we cannot change it as it leads to binary changes.
+ // We can do it in 3.0 or when we found incompatibility with kotlinx.serialization.
+
/**
* 并发类型
*/