From a87a1bfcdab0fa42d169f630e9eab85137e50e29 Mon Sep 17 00:00:00 2001 From: David Baumgold Date: Wed, 7 Aug 2013 16:14:07 -0400 Subject: [PATCH] Docstrings --- cms/djangoapps/contentstore/views/preview.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/cms/djangoapps/contentstore/views/preview.py b/cms/djangoapps/contentstore/views/preview.py index 202927bdfb..1fef30dd99 100644 --- a/cms/djangoapps/contentstore/views/preview.py +++ b/cms/djangoapps/contentstore/views/preview.py @@ -164,13 +164,16 @@ def load_preview_module(request, preview_id, descriptor): def get_preview_html(request, descriptor, idx): + """ + Returns the HTML for the XModule specified by the descriptor and idx. + """ module = load_preview_module(request, str(idx), descriptor) return module.runtime.render(module, None, "student_view").content def get_module_previews(request, descriptor): """ - Returns a list of preview XModule html contents. One preview is returned for each + Returns a tuple of preview XModule html contents. One preview is returned for each pair of states returned by get_sample_state() for the supplied descriptor. descriptor: An XModuleDescriptor