From 91ad3db55ac3d49ff9f5c2499d74543c796cd597 Mon Sep 17 00:00:00 2001 From: Raul Gallegos Date: Tue, 26 Jan 2021 12:21:04 -0500 Subject: [PATCH] improves settings_description for XBLOCK_SETTINGS with reference --- lms/envs/common.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lms/envs/common.py b/lms/envs/common.py index 038711a5d4..c05e2ce9f0 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -1210,7 +1210,10 @@ XBLOCK_FS_STORAGE_PREFIX = None # .. setting_name: XBLOCK_SETTINGS # .. setting_default: {} -# .. setting_description: Dictionary containing server-wide configuration of XBlocks on a per-type basis +# .. setting_description: Dictionary containing server-wide configuration of XBlocks on a per-type basis. +# By default, keys should match the XBlock `block_settings_key` attribute/property. If the attribute/property +# is not defined, use the XBlock class name. Check `common.lib.xmodule.xmodule.services.SettingsService` +# for more reference. XBLOCK_SETTINGS = {} ############# ModuleStore Configuration ##########