From e7b771137edf926ec00161d4c1d7e916cc58a907 Mon Sep 17 00:00:00 2001
From: Igor Zolotarev <yngvar.antonsson@gmail.com>
Date: Tue, 14 Nov 2023 13:47:47 +0300
Subject: [PATCH] Extend get_enabled_roles docs

---
 cartridge/roles.lua | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/cartridge/roles.lua b/cartridge/roles.lua
index 670d21ef3..033a6737b 100644
--- a/cartridge/roles.lua
+++ b/cartridge/roles.lua
@@ -267,6 +267,10 @@ local enabled_roles_cache = setmetatable({}, {__mode = 'k'})
 -- This function returns all roles that will be enabled
 -- including their dependencies (both hidden and not)
 -- and permanent roles.
+-- By default, only permanent roles are returned.
+-- When you pass table with the roles names as an argument,
+-- This function also checks their dependencies and
+-- returns them as well.
 --
 -- @function get_enabled_roles
 -- @local