From f15efb49300117f96c29f4ec66fd73212979f9c5 Mon Sep 17 00:00:00 2001
From: "Zaiming (Stone) Shi" <zmstone@gmail.com>
Date: Thu, 16 Dec 2021 22:08:16 +0100
Subject: [PATCH] chore: add a function comment

---
 apps/emqx_plugins/src/emqx_plugins.erl | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/apps/emqx_plugins/src/emqx_plugins.erl b/apps/emqx_plugins/src/emqx_plugins.erl
index 9252ac957..a7dc8789b 100644
--- a/apps/emqx_plugins/src/emqx_plugins.erl
+++ b/apps/emqx_plugins/src/emqx_plugins.erl
@@ -194,6 +194,11 @@ delete_package(NameVsn) ->
     end.
 
 %% @doc Delete extracted dir
+%% In case one lib is shared by multiple plugins.
+%% it might be the case that purging one plugin's install dir
+%% will cause deletion of loaded beams.
+%% It should not be a problem, because shared lib should
+%% reside in all the plugin install dirs.
 -spec purge(name_vsn()) -> ok.
 purge(NameVsn) ->
     Dir = dir(NameVsn),