From 24f528cfa6b14bf5fe167aa40145f23463c7b9db Mon Sep 17 00:00:00 2001 From: Raul Gallegos Date: Mon, 25 Jan 2021 19:56:41 -0500 Subject: [PATCH] adds annotations for XBLOCK_SELECT_FUNCTION improves the setting_description for XBLOCK_SELECT_FUNCTION removes extra setting_description --- lms/envs/common.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/lms/envs/common.py b/lms/envs/common.py index f5a485b079c4..9b6f48507e18 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -1212,7 +1212,12 @@ def _make_mako_template_dirs(settings): # once the responsibility of XBlock creation is moved out of modulestore - cpennington XBLOCK_MIXINS = (LmsBlockMixin, InheritanceMixin, XModuleMixin, EditInfoMixin) -# Allow any XBlock in the LMS +# .. setting_name: XBLOCK_SELECT_FUNCTION +# .. setting_default: prefer_xmodules +# .. setting_description: Function used to select an XBlock from the python package EntryPoints. +# Some alternatives are `prefer_xmodules` and `default_select`. The `prefer_modules` function +# will choose the first "xmodule" if there is one, otherwise, it will act like `default_select`. +# The `default_select` function will simply choose the first match found. XBLOCK_SELECT_FUNCTION = prefer_xmodules # .. setting_name: XBLOCK_FIELD_DATA_WRAPPERS