Skip to content

Commit 5a66bfa

Browse files
authored
Correct some typos in Readme.md (#193)
1 parent 22ba2ab commit 5a66bfa

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

Readme.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ However, it is also possible to configure CodeRunner questions so
127127
that the mark is determined by how many of the tests the code successfully passed.
128128

129129
CodeRunner has been in use at the University of Canterbury for over ten years
130-
running many millions of student quiz question submissions in Python, C , JavaScript,
130+
running many millions of student quiz question submissions in Python, C, JavaScript,
131131
PHP, Octave and Matlab. It is used in laboratory work, assignments, tests and
132132
exams in multiple courses. In recent years CodeRunner has spread around the
133133
world and as of January 2021 is installed on over 1800 Moodle sites worldwide
@@ -374,7 +374,7 @@ the code or OS features within the Jobe container, e.g. to install new languages
374374

375375
If you intend running unit tests you
376376
will also need to copy the file `tests/fixtures/test-sandbox-config-dist.php`
377-
to 'tests/fixtures/test-sandbox-config.php', then edit it to set the correct
377+
to `tests/fixtures/test-sandbox-config.php`, then edit it to set the correct
378378
host and any other necessary configuration for the Jobe server.
379379

380380
Assuming you have built *Jobe* on a separate server, suitably firewalled,
@@ -399,7 +399,7 @@ are installed.
399399

400400
Before running any tests you first need to copy the file
401401
`<moodlehome>/question/type/coderunner/tests/fixtures/test-sandbox-config-dist.php`
402-
to '<moodlehome>/question/type/coderunner/tests/fixtures/test-sandbox-config.php',
402+
to `<moodlehome>/question/type/coderunner/tests/fixtures/test-sandbox-config.php`,
403403
then edit it to set whatever configuration of sandboxes you wish to test,
404404
and to set the jobe host, if appropriate. You should then initialise
405405
the phpunit environment with the commands
@@ -805,7 +805,7 @@ where a 'match' is defined by the chosen grader: an exact match,
805805
a nearly exact match or a regular-expression match. There is also the possibility
806806
to perform grading with the the template itself using a 'template grader';
807807
this possibility is discussed later, in the section
808-
'[Grading with templates'](#grading-with-templates).
808+
[Grading with templates](#grading-with-templates).
809809

810810
Expansion of the template is done by the
811811
[Twig](http://twig.sensiolabs.org/) template engine. The engine is given both
@@ -1404,10 +1404,10 @@ student's first name:
14041404
first_name = args['firstname']
14051405
print(json.dumps({'func_name': func_name, 'first_name': first_name}))
14061406

1407-
The question text could then say
1407+
The question text could then say:
14081408

1409-
Write a function {{ func_name }}() that prints a welcome message of the
1410-
form "Hello {{ first_name }}!".
1409+
`Write a function {{ func_name }}() that prints a welcome message of the
1410+
form "Hello {{ first_name }}!".`
14111411

14121412
Note that this simple example is chosen only to illustrate
14131413
the technique. It is a very bad example of *when* to use
@@ -1502,9 +1502,9 @@ they are not available as global variables.
15021502
Other fields are:
15031503

15041504
* `QUESTION.name` The name of the question.
1505-
* `QUESTION.generalfeedback The contents of the general feedback field in the
1505+
* `QUESTION.generalfeedback` The contents of the general feedback field in the
15061506
question authoring form.
1507-
* `QUESTION.generalfeedbackformat. The format of the general feedback. 0 = moodle,
1507+
* `QUESTION.generalfeedbackformat` The format of the general feedback. 0 = moodle,
15081508
1 = HTML, 2 = Plain, 3 = Wiki, 4 = Markdown.
15091509
* `QUESTION.questiontext` The question text itself
15101510
* `QUESTION.answerpreload` The string that is preloaded into the answer box.
@@ -3252,19 +3252,19 @@ a course before attempting to run the scripts.
32523252

32533253
The three scripts are:
32543254

3255-
1. &lt;moodle_home&gt;/question/type/coderunner/bulktestindex.php
3255+
1. `&lt;moodle_home&gt;/question/type/coderunner/bulktestindex.php`
32563256
This script displays a list of all question categories accessible to the
32573257
user who is currently logged into Moodle on the machine running the script.
32583258
Each category is displayed as a clickable link that then runs a script that
32593259
tests the sample answers on all questions in that category, reporting
32603260
all successes and failures.
32613261

3262-
1. &lt;moodle_home&gt;/question/type/coderunner/prototypeusageindex.php
3262+
1. `&lt;moodle_home&gt;/question/type/coderunner/prototypeusageindex.php`
32633263
This scripts displays an index like the one above except that the
32643264
clickable links now run a script that reports on the question prototype
32653265
usage within that category.
32663266

3267-
1. &lt;moodle_home&gt;/question/type/coderunner/downloadquizattempts.php
3267+
1. `&lt;moodle_home&gt;/question/type/coderunner/downloadquizattempts.php`
32683268
This script
32693269
displays a list of all quizzes available to the logged in user,
32703270
allowing them to download a spreadsheet of all submissions to a selected quiz
@@ -3356,7 +3356,7 @@ The three scripts are:
33563356
To assist the use of screen readers for visually impaired students,
33573357
text area inputs now have two modes:
33583358

3359-
* When keyboard focus first enters them via Tab or Shift+TAb, they are
3359+
* When keyboard focus first enters them via Tab or Shift+TAB, they are
33603360
in 'non-capturing' mode, and pressing TAB or Shift+TAB moves to the
33613361
next or previous form control.
33623362

0 commit comments

Comments
 (0)