Skip to content

Incorrect documentation for multiple-choice questions with multiple answers #165

@priyashuu

Description

@priyashuu

Current Behavior

The archetypes/test.md show multiple-choice questions with multiple correct answers using type: "mcq" with an additional multiple_answers: true field. This configuration is incorrect and may cause rendering or functionality issues.

Current (Incorrect) Implementation

Image

Environment

  • Host OS: All (documentation issue)

--- Expected Behavior
Questions with multiple correct answers should use type: "multiple-answers" without the multiple_answers: true field. The type declaration alone should determine the question behavior.

- id: "q4"
  text: "What are the purposes of the 'defer' keyword in Go? (Select all that apply)"
  type: "multiple-answers"
  marks: 2
  explanation: "..."
  options:
    - id: "a"
      text: "..."
      is_correct: true

Issues

  1. The type should be "multiple-answers" instead of "mcq"
  2. The multiple_answers: true field should be removed (it's redundant)

Question Type Reference

  • type: "mcq" - Single correct answer (radio buttons)
  • type: "multiple-answers" - Multiple correct answers (checkboxes)
  • type: "short_answer" - Text input for short responses

Impact

This incorrect documentation may lead users to configure their test questions incorrectly, potentially causing rendering or functionality issues.

Contributor Guide and Resources

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind/bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions