refactor: QuestionDisplayOptions.feedback renamed to specific_feedback

questionpy-org · Oct 29, 2024 · 340be86 · 340be86
1 parent 3f8a855
commit 340be86
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/questionpy_sdk/webserver/attempt.py b/questionpy_sdk/webserver/attempt.py
@@ -68,7 +68,7 @@ def get_attempt_render_context(
         context["general_feedback"] = html
         if errors:
             context["render_errors"]["General Feedback"] = errors
-    if display_options.feedback and attempt.ui.specific_feedback:
+    if display_options.specific_feedback and attempt.ui.specific_feedback:
         html, errors = QuestionUIRenderer(attempt.ui.specific_feedback, *renderer_args).render()
         context["specific_feedback"] = html
         if errors:

diff --git a/questionpy_sdk/webserver/question_ui/__init__.py b/questionpy_sdk/webserver/question_ui/__init__.py
@@ -174,7 +174,7 @@ class QuestionDisplayRole(StrEnum):
 
 class QuestionDisplayOptions(BaseModel):
     general_feedback: bool = True
-    feedback: bool = True
+    specific_feedback: bool = True
     right_answer: bool = True
     roles: set[QuestionDisplayRole] = {
         QuestionDisplayRole.DEVELOPER,
@@ -323,7 +323,7 @@ def _hide_unwanted_feedback(self) -> None:
             # Check conditions to remove the element
             if not (
                 (feedback_type == "general" and self._options.general_feedback)
-                or (feedback_type == "specific" and self._options.feedback)
+                or (feedback_type == "specific" and self._options.specific_feedback)
             ):
                 _remove_element(element)
 

diff --git a/questionpy_sdk/webserver/routes/attempt.py b/questionpy_sdk/webserver/routes/attempt.py
@@ -80,7 +80,7 @@ async def get_attempt(request: web.Request) -> web.Response:
     if not score:
         # TODO: Allow manually set display options to override this.
         display_options.readonly = False
-        display_options.general_feedback = display_options.feedback = display_options.right_answer = False
+        display_options.general_feedback = display_options.specific_feedback = display_options.right_answer = False
 
     context = get_attempt_render_context(
         attempt,

diff --git a/tests/questionpy_sdk/webserver/test_question_ui.py b/tests/questionpy_sdk/webserver/test_question_ui.py
@@ -109,7 +109,7 @@ def test_should_resolve_placeholders(renderer: QuestionUIRenderer) -> None:
 
 
 @pytest.mark.ui_file("feedbacks")
-@pytest.mark.render_params(options=QuestionDisplayOptions(general_feedback=False, feedback=False))
+@pytest.mark.render_params(options=QuestionDisplayOptions(general_feedback=False, specific_feedback=False))
 def test_should_hide_inline_feedback(renderer: QuestionUIRenderer) -> None:
     expected = """
         <div>