Reviewing a lecture
What to look for, and what to skip
Read for meaning first. This page lists what matters most in a review, in order, and the parts of a lecture that you can skip.
What matters most
In order of importance:
- Meaning errors. A sentence that says something different from the English, even when it reads fluently. A machine translation can sound natural and still be wrong. Errors like this need a careful reader who knows both languages.
- Terms. A term that is wrong, that disagrees with your language's glossary, or that the lecture handles in two ways.
- Register and punctuation that depart from your edition's house style.
- Unnatural language. Wording that a good textbook in your language would not use.
- Code comments, if the draft translates them.
Your language page records the term rules and the house style for your edition. Terms and house style explains how they are settled.
A wrong term is probably wrong elsewhere
A term that is wrong in one lecture is probably wrong in others. Correct it in this lecture as usual, and say once, in your comment, that it is probably wrong elsewhere too. The term then goes into the glossary, so that the lectures drafted after it use the right term.
Preferences are welcome
You can suggest a change when the draft is correct but you would write it differently. Preferences are useful, because they show how a native writer would say it.
Say when a change is a preference rather than an error. Add a word such as “preference” to the comment, above the suggestion. This helps @mmcky decide what the engine should learn from your review.
What to skip
- Errors in the English. Report them, so that they are corrected in the English lecture. See Errors in the English.
- The block at the top of the file, including its
translation:part. See Reading a review pull request. - Code, program output and screenshots. They stay as they are. Code comments are the exception, where the draft translates them.
- Structure. A script checks the number and order of headings, code cells and other elements against the English before the pull request opens. You need to check only their text.
- Anything your language page says the engine already handles. In Malayalam, for example, the headings, the code cells and the Exercises section stay identical to the English. A script checks them, so they need no proofreading.
Headings
Headings are text like any other, so review them too, unless your language page says that they stay in English. If you change a heading, @mmcky updates the heading map in the translation: block when applying your suggestion. You do not need to edit the block yourself.