Policies
Errors in the English
A careful review often finds mistakes in the English lectures themselves. They are corrected upstream, in the English repository, so that every edition benefits.
Corrections go upstream
Each edition is translated from an English lecture series. The English repository is upstream, and the editions are downstream. When the English is corrected, every edition gains the correction. Lectures drafted later start from the corrected English. Once an edition is complete, sync pull requests carry the correction into it. See Sync reviews.
A correction made only in your translation helps only your edition, and a later change to the English can undo it.
How to report a mistake
Open an issue in the English repository, using the issue lists below, so that the mistake is fixed there. Name the lecture, quote the sentence and say what is wrong. Write the issue in English.
You may use AI tools to help you write this issue, for example to check your English. The rule in Review by hand covers your review of the translation, not reports to the English repository.
| English series | Issue list |
|---|---|
| Python Programming for Economics and Finance | QuantEcon/lecture-python-programming |
| A First Course in Quantitative Economics with Python | QuantEcon/lecture-python-intro |
| Intermediate Quantitative Economics with Python | QuantEcon/lecture-python.myst |
In the translation
Then comment on the translated line with a link to your issue. That is all: keep the translation to the English as it stands. Your review pull request goes ahead without waiting for the fix. When the English is corrected, the correction reaches your edition the next time the lecture is synced.
Keep to the English
Do not add sections, explanations or examples that are not in the English, even when they would help readers. The engine keeps each translated lecture matched to its English lecture, section by section:
- a section with no match in the English is removed the next time the lecture is synced;
- when the English of a section changes, the engine updates that section to match the new English, and text added to it can be lost.
If you think the English lecture should explain something better, suggest it upstream, in an issue in the English repository. Then every edition can gain it. The action-translation FAQ explains how a sync treats content that is not in the English.