Skip to content

Updating the "troubleshooting" section #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updating the "troubleshooting" section #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,10 @@ jassign tests/example.ipynb tests/output some/course
* the `autograder` directory contains the full set of tests and a solution notebook (a solution notebook is different from the master notebook, because it is not formatted accordidng to the [notebook format](docs/notebook-format.md) but instead looks like the student notebook with solutions)
* the `student` directory contains an automatically created redacted version.
* **Note**: currently, the output directories will **not** contain the data files, e.g., csv or json files, that you used when creating the master notebook: make sure you add them to the `student` directory before releasing it to students
* `some/course` is the endpoint/path of the assignment that's listed on okpy (typically starts with your university abbreviation and has a course name in it, ending with the assignment name).


Before you run the `jassign` command, make sure that you **run the entire notebook** top to bottom (`Cell -> Run All`) to make sure that every cell has the correct output -- the output of the cells will be turned into the appropriate tests stored in the provided output directory (second argument of the `jassign` command). If you change the tests, you need to re-generate the files by re-running the notebook and the `jassign` command. **Note**: `jassign` will issue an error and quit if the output directory already exists.
* `some/course` is the endpoint/path of the assignment that's listed on okpy.org when you create the new assignment (typically starts with your university abbreviation and has a course name in it, ending with the assignment name).


Before you run the `jassign` command, **run the entire notebook** top to bottom (`Cell -> Run All`) to make sure that every cell has the correct output -- the output of the cells will be turned into the appropriate tests stored in the provided output directory (second argument of the `jassign` command). If you change the tests, you need to re-generate the files by re-running the notebook and the `jassign` command. **Note**: `jassign` will issue an error and quit if the output directory already exists, so you need to remove the output directory first (taking care to keep the master solution notebook safe).


You can then generate a PDF from the result:
Expand All @@ -45,9 +43,9 @@ jassign-pdf tests/output/autograder/example.ipynb tests/output/autograder/exampl
```


## Caution
# Caution / Troubleshooting

#### Test outside of a question
### PROBLEM: "Test outside of a question"

```
File "/opt/conda/lib/python3.6/site-packages/jassign/to_ok.py", line 141, in gen_ok_cells
Expand All @@ -57,23 +55,21 @@ AssertionError: Test outside of a question:

If you get this error, this means that you have _more than one cell_ between the markdown cell that declared the question (i.e., the one that contains `#BEGIN QUESTION`) and the cell that contains the `# TEST`.


**SOLUTION**: remove the extra code/markdown cell(s) either between the solution cell and the markdown cell with the `#BEGIN QUESTION` or between the solution cell and the `# TEST` cell.

#### Test cell with a blank on the last line

### PROBLEM: Test cell with a blank on the last line

If your test contains a blank/newline after the test, jassign seems to automatically add a semicolon at the end of the test, thus, supressing the output of the command.

Example:

```
# TEST
movies.head(1)['plots'][0]=='Two imprisoned men bond over a number of years, finding solace and eventual redemption through acts of common decency.'

```

Turns into the following failed test in the students' notebook:

The above statement turns into the following failed test in the students' notebook:
```
>>> movies.head(1)['plots'][0]=='Two imprisoned men bond over a number of years, finding solace and eventual redemption through acts of common decency.';
>>>
Expand All @@ -83,5 +79,11 @@ Turns into the following failed test in the students' notebook:
# but got

```

**SOLUTION**: remove the blank line at the end of the `# TEST` cell.


### PROBLEM: `# SOLUTION` shows up in the student notebook

If your test has no space between the `#` and a command before it, then that line will show up in the student notebook, even though it is marked as `# SOLUTION`.

**SOLUTION**: add a space before the test command and `# SOLUTION` and re-run the jassign command to update the tests.