Skip to content

[python_by_example] Corrections de style et de terminologie - #25

Merged
mmcky merged 1 commit into
QuantEcon:mainfrom
Honaminto:fix/python_by_example-2
Aug 4, 2026
Merged

[python_by_example] Corrections de style et de terminologie#25
mmcky merged 1 commit into
QuantEcon:mainfrom
Honaminto:fix/python_by_example-2

Conversation

@Honaminto

Copy link
Copy Markdown
Contributor

I'm providing a full review of python_by_example.md against the English python_by_example doc.

I describe the list of changes I did.

Un exemple introductif

  • "Nous sommes maintenant prêts à commencer à apprendre le langage Python lui-même." ---> "Nous sommes maintenant prêts à aborder le langage Python proprement dit."
  • "Des concepts plus approfondis seront abordés dans les cours ultérieurs." ---> "Les notions plus avancées seront abordées dans les chapitres suivants."

Objectif

  • "La tâche : tracer un processus de bruit blanc" ---> "Objectif : simuler et représenter un processus de bruit blanc" (body + YAML headings)
  • "Importations" ---> "Importation de bibliothèques" (body + YAML headings)

Importation de bibliothèques

  • "NumPy, un package Python privilégié pour des tâches telles que" ---> "NumPy, une bibliothèque Python très utilisée pour des tâches telles que"
  • "L'avantage est qu'il y a moins à taper si nous utilisons sqrt souvent dans notre code." ---> "Cette écriture permet d'alléger le code lorsque la fonction sqrt est utilisée fréquemment."
  • "Il est alors plus difficile pour les lecteurs de savoir d'où vient sqrt, s'ils le souhaitent." ---> "En revanche, dans un programme long, il peut devenir plus difficile de déterminer de quelle bibliothèque provient sqrt."

Tirages aléatoires

  • "Nous pouvons et allons examiner ci-dessous diverses façons de configurer et d'améliorer ce graphique." ---> "Nous verrons plus loin différentes façons de configurer et d'améliorer ce graphique."

Implémentations alternatives

  • "Mais ils nous aident à illustrer une syntaxe et une sémantique Python importantes dans un cadre familier." ---> "Ils permettent néanmoins d'illustrer, dans un contexte familier, plusieurs éléments importants de la syntaxe et du fonctionnement de Python."

Listes

  • "Les listes sont une structure de données native de Python utilisée pour regrouper une collection d'objets." ---> "Une liste est une structure de données native de Python qui permet de regrouper plusieurs objets."

Méthodes

  • "Nous apprendrons tout sur les méthodes plus tard, mais juste pour vous donner une idée," ---> "Nous étudierons les méthodes plus en détail dans un chapitre ultérieur. Pour le moment, retenons simplement que :"

La boucle for

  • "Ces deux lignes sont appelées un bloc de code, car elles constituent le « bloc » de code sur lequel nous bouclons." ---> "Ces deux lignes constituent un bloc de code, c'est-à-dire l'ensemble des instructions répétées à chaque itération."
  • "Python connaît l'étendue du bloc de code uniquement grâce à l'indentation." ---> "Python détermine les limites du bloc de code uniquement à partir de l'indentation."
  • "Supprime l'encombrement, comme les accolades ou les instructions de fin utilisées dans d'autres langages." ---> "Évite certains éléments syntaxiques supplémentaires, comme les accolades ou les mots-clés de fin utilisés dans d'autres langages."

Boucles while (logic fix, not just style)

  • "Une boucle while continuera d'exécuter le bloc de code jusqu'à ce que la condition soit satisfaite." ---> "Une boucle while exécute le bloc de code délimité par l'indentation tant que la condition (i < ts_length) est vraie."
  • Fixed code comment spacing: #la condition de fin de la boucle while ---> # la condition de fin de la boucle while

Une autre application

  • "Ces nombres sont remplis par la boucle for." ---> "Ces nombres sont remplis au moyen de la boucle for."
  • "...car cette dernière doit demander de manière répétée de l'espace de stockage au système d'exploitation." ---> "...car l'utilisation répétée de cette dernière peut nécessiter de nouvelles allocations de mémoire."

Exercice 4

  • "Un aspect important de pratiquement tous les langages de programmation est le branchement et les conditions." ---> "Les branchements conditionnels constituent un élément essentiel de presque tous les langages de programmation."

Exercice 1

  • "Posez T=200 et α = 0.9." ---> "On pose T = 200 et α = 0.9."

Exercice 5 (Monte-Carlo)

  • "à mesure que n devient grand" ---> "lorsque n devient suffisamment grand"
  • "la probabilité d'atterrir dans B" ---> "la probabilité que U appartienne à B"
  • "en échantillonnant des uniformes bivariées" ---> "en générant des observations d'une loi uniforme bidimensionnelle"
  • Hint: "$area = \pi * radius^2$" ---> "$aire = \pi * rayon^2$"
  • Solution, final comment: # division par radius2 ---> # division par rayon2

@Honaminto

Copy link
Copy Markdown
Contributor Author

Hours logged ( python_by_example.md & numpy.md)

Period: Jul 23 – Aug 3, 2026
Total: ~29h45

Date What I worked on Time
Jul 23 Git setup, getting the workflow straight 1h30
Jul 23–24 Wrapped up PR #78 (glossary terms) 1h
Jul 24–25 Read through python_by_example.md against the English version 2h
Jul 25 Wrote up the list of corrections for python_by_example 1h
Jul 28 Applied those corrections 1h
Jul 28–29 Read through numpy.md — longer file, more technical 4h
Jul 29 Checked terminology against French Wikipedia, NumPy's French docs, and a couple of programming references, to make sure things like "masque booléen" and "sous-package" were actually the right call 2h30
Jul 29–30 Wrote up the numpy.md correction list (53 items — sorted what to apply, skip, or leave for later) 2h
Jul 30 Applied the numpy.md corrections 1h30
Jul 30 Windows credential manager kept crashing on push, lost a while to that 1h30
Jul 30–31 Sorted out pushing to my fork vs. QuantEcon directly (403 errors, remote config) 1h
Aug 1 main branch had drifted (ahead/behind), had to reset it cleanly 1h30
Aug 1 PR #19 got wiped out by accident during the branch cleanup, rebuilt it 1h
Aug 1–3 Went back and double-checked non-breaking spaces and that nothing extra got changed in either file 1h30
Aug 1 numpy.md PR — first attempt had duplicate files in it, closed it and redid it clean (#23#24) 1h30
Aug 3 python_by_example.md PR, rebuilt after the #19 mess (→ #25) 1h
Aug 1–3 Wrote the PR descriptions 1h
Aug 3 Wrote up the tic/toc issue for the English repo 45m

@mmcky

mmcky commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Merci Emile — validated the same way as #24 (fidelity vs English, French quality, technical integrity, independently double-checked): 18 of 25 changes are clear improvements, none major-negative, both code-cell changes are comment-only, and your heading renames follow the heading-map contract exactly (body + YAML together — textbook usage, the sync engine will pick the new titles up cleanly). Recommendation is to merge.

Your two "logic" fixes are both defects in the English source, which the machine translation had reproduced faithfully:

  • the while-loop sentence — English says the loop runs "until the condition (i < ts_length) is satisfied", which is inverted; your « tant que la condition … est vraie » is correct, and we're filing the English fix upstream so a future sync can't revert you;
  • the append memory claim — your « peut nécessiter de nouvelles allocations de mémoire » is actually more accurate than the English "must repeatedly ask the operating system for storage" (CPython over-allocates, so OS calls are amortised).

Five small things, none blocking:

  1. One plain space before « : » slipped in (« retenons simplement que : ») — the file convention is U+00A0 before high punctuation.
  2. « En revanche, dans un programme long… » — the English "Then it's harder…" is a consequence of the disadvantage just stated, not a contrast; something like « Il devient alors plus difficile… » would keep the logic (and avoid the « long programme »/« programme long » repetition with the previous sentence).
  3. In the Exercise 5 solution you wrote « loi uniforme bidimensionnelle » while the (unchanged) hint says « bivariée » — the glossary pins Bivariate uniform distribution → Loi uniforme bivariée, so unless you'd argue for changing that pin, the solution should say « bivariée » too.
  4. « une bibliothèque Python très utilisée » for NumPy reads well, but the unchanged Packages subsection still opens « Comme indiqué ci-dessus, NumPy est un package Python » — which now refers to a statement that no longer exists above. Worth a small touch-up in the same spirit (and tell us: where should « package » stay « package »? Your call here becomes the engine's rule).
  5. Optional polish: « aborder … proprement dit » + « seront abordées » land within four sentences — e.g. « seront traitées dans les chapitres suivants » would vary it.

The « cours » vs « chapitre » question from #24 applies here too (this file now has both). One ruling from you settles the series.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants