diff --git a/docs/otter_assign/notebook_format.rst b/docs/otter_assign/notebook_format.rst index 89e4c4f4..6e013e11 100644 --- a/docs/otter_assign/notebook_format.rst +++ b/docs/otter_assign/notebook_format.rst @@ -2,7 +2,7 @@ Notebook Format =============== Otter's notebook format groups prompts, solutions, and tests together into questions. Autograder tests -are specified as cells in the notebook and their output is used as the expected output of the +are specified as cells in the notebook and each cell's output is used as the expected output of the autograder when generating tests. Each question has metadata, expressed in raw YAML config cell when the question is declared. @@ -489,6 +489,12 @@ cell; Otter Assign will parse the output of the cell to write a doctest for the be used for the test case. **Make sure that only the last line of the cell produces any output, otherwise the test will fail.** +.. important:: + Because Otter Assign parses the output of the cell, you must save the notebook without + clearing the cell outputs. If you run Otter Assign on a notebook with the outputs cleared, every + test case will be parsed in such a way that it expects no output to be printed at all, which will + likely result in failing test cases for correct answers. + Exception-Based Test Cells ?????????????????????????? diff --git a/docs/tutorial.rst b/docs/tutorial.rst index 22b5d9df..d02dff51 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -46,6 +46,12 @@ Otter Assign on this notebook, run otter assign demo.ipynb dist + +.. important:: + If you have viewed/edited the ``demo.ipynb`` notebook, make sure that you run all of the + cells and save the notebook with the cell outputs included, otherwise Otter Assign will generate + incorrect test cases. + Otter Assign should create a ``dist`` directory which contains two further subdirectories: ``autograder`` and ``student``. The ``autograder`` directory contains the Gradescope autograder, solutions PDF, and the notebook with solutions. The ``student`` directory contains just the