From 265547213cc67cc0c1615302367593ce888fb899 Mon Sep 17 00:00:00 2001
From: Dossy Shiobara <dossy@panoptic.com>
Date: Mon, 20 Mar 2023 22:14:27 -0400
Subject: [PATCH] docs: clarify empty patches array behavior (#610)

Co-authored-by: Ven <vendicated@riseup.net>
---
 docs/2_PLUGINS.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/docs/2_PLUGINS.md b/docs/2_PLUGINS.md
index 705ea89d6..7b5e3e181 100644
--- a/docs/2_PLUGINS.md
+++ b/docs/2_PLUGINS.md
@@ -26,6 +26,10 @@ export default definePlugin({
             name: "Your Name",
         },
     ],
+    // Delete `patches` if you are not using code patches, as it will make
+    // your plugin require restarts, and your stop() method will not be
+    // invoked at all.  The presence of the key in the object alone is
+    // enough to trigger this behavior, even if the value is an empty array.
     patches: [],
     // Delete these two below if you are only using code patches
     start() {},