From 5d93f883f1cbe5442675db7e88d8d4bf0a1114ea Mon Sep 17 00:00:00 2001 From: Braden MacDonald Date: Thu, 2 Jun 2022 13:59:30 -0700 Subject: [PATCH] docs: Clarify a potentially confusing deprecation message --- openedx/core/djangoapps/xblock/runtime/shims.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/openedx/core/djangoapps/xblock/runtime/shims.py b/openedx/core/djangoapps/xblock/runtime/shims.py index 516521d412..b23643393b 100644 --- a/openedx/core/djangoapps/xblock/runtime/shims.py +++ b/openedx/core/djangoapps/xblock/runtime/shims.py @@ -143,7 +143,9 @@ class RuntimeShim: """ warnings.warn( "Use of runtime.render_template is deprecated. " - "Use xblockutils.resources.ResourceLoader.render_mako_template or a JavaScript-based template instead.", + "For template files included with your XBlock (which is preferable), use " + "xblockutils.resources.ResourceLoader.render_mako_template to render them, or use a JavaScript-based " + "template instead. For template files that are part of the LMS/Studio, use the 'mako' XBlock service.", DeprecationWarning, stacklevel=2, ) try: