Skip to content

Proposal: review each remaining lecture as a fresh draft on its own PR #82

Description

@mmcky

@Honaminto — thank you for your answers of 23 September on #77, #78, #80 and #42. They are all recorded below, under "What stays the same". This issue is a proposal about the 22 pages you have not reviewed yet, for you and @mmcky to settle together here. In short: instead of correcting the French that is on main now, you would review one lecture at a time as a fresh draft (a new translation made from the current English by the current version of the translation tool), opened as its own pull request. Carrying on as now is a perfectly good answer too; nothing changes unless you agree. (#40 says the translations are not regenerated during the review; this would change that, but only for the lectures you have not reviewed yet.)

What we propose

For each remaining lecture, when you are ready for it:

  1. We make a fresh draft, check it (structure and code against the English, French typography, your rulings) and open it as its own PR. The PR replaces the lecture's current French, comes with a rendered preview, and says which version of the tool and which model made the draft, what we checked and anything we changed by script.
  2. You review it on the PR in whatever way suits you: commit to the PR's branch directly (you now have write access), leave suggestion blocks, or write your numbered before/after list in a review comment, like the lists in your earlier PRs. We apply suggestions and lists for you, with you credited as co-author.
  3. When your review is complete, approve the PR or say so on it, and leave the merge to us. (On Review of the French translation of Names and Namespaces #80 we said you could merge pull requests; for these drafts we would merge, because we update the tool at the same time.) We then go through your corrections, update the lecture and merge it.
  4. Before the next lecture is drafted, we put what you corrected into the tool where it applies more widely (glossary entries, rules, automatic checks), so that a correction you make once is less likely to come back in the next lecture.
  5. The merged lecture is kept as a reference for measuring later versions of the tool.

The Malayalam edition (QuantEcon/lecture-python-programming.ml) has been reviewed this way since August, and the new Japanese edition (QuantEcon/lecture-python-programming.ja, being set up now) will be built and reviewed this way from its first lecture.

Why

What would change for you

  • You would review a PR that replaces the lecture's current French, rather than opening your own PR against it. The "Files changed" view will show most of the prose as changed (about two lines in three in our test drafts), but lines that the new draft words exactly as before show as unchanged, and some are folded out of view, so please read the whole lecture in the preview. Suggestions work on any line the view shows; for any other line, a plain comment on the PR is fine.
  • Every PR has a rendered preview. None of your seven PRs so far had one, because they came from your fork (with write access, a branch of your own in this repository would now get one too).
  • Automatic reviews (GitHub's Copilot, and our own translation check) may comment on these PRs. They need no attention from you.
  • We would open each lecture when you are ready for it, not all 22 at once. One at a time is slower than having several lectures open: between lectures there is a gap of some days while we put your corrections into the tool and make the next draft.
  • Each lecture's item on French translation review — native-speaker read-through (project tracker) #40 still completes when that lecture's PR merges.

What stays the same

Costs and open points

  • A fresh draft replaces everything in that lecture: the July text, passages the sync has updated since, and corrections we made by hand (for example in Round-2 consistency pass: espace de nommage and renvoyer edition-wide, plus two hand-ports #81). That is fine for a lecture nobody has reviewed, because the draft is translated from the current English and so already includes the English changes; we check each draft against your rulings before opening it.
  • Terms the glossary does not cover can come out differently from one draft to the next. When one reads wrong, or differs from a lecture you have reviewed, say so on the PR and it goes into the glossary before the next draft.
  • Index entries. You said on Update oop_intro.md #78 that the index entries should be in French throughout. The tool still writes them in English, so until it can, we would translate them in each draft before it reaches you, and we will still make the one pass over the whole edition that we agreed on, so the index is consistent in the meantime.
  • More than one draft. We may make more than one draft of a lecture and open the cleanest; the PR would say so.
  • If the English changes a lecture while its PR is open, we bring the PR up to date. There is nothing for you to do.

Questions for you

  1. Would you prefer to review the remaining lectures this way, or to carry on as now?
  2. Any concerns, for example about reading a new draft rather than the current text, or about the pace?
  3. Which lecture next? Your fork has a review/python-oop branch, so perhaps python_oop.md (Review: python_oop.md #51). If you have already started on it, you could finish it the current way and start the new way with the lecture after; if not, it could be the first fresh draft.

If the proposal is adopted, @mmcky then brings #40 and the open lecture items in line with it, as a separate follow-up.

Done when

  • @Honaminto and @mmcky agree here on how the remaining lectures are reviewed, and the outcome is recorded in a comment on this issue.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions