Skip to content

Review Translation: 编写高质量代码 (writing_good_code.md) #42

@mmcky

Description

@mmcky

Translation Review: 编写高质量代码

Lecture file: lectures/writing_good_code.md
English source: https://python-programming.quantecon.org/writing_good_code.html
Reviewer: assign below


Instructions

  1. Compare the Chinese translation against the English source
  2. Work through each checklist section below
  3. Open a Pull Request with any fixes, referencing this issue (e.g., Fixes #<issue_number> or Relates to #<issue_number>)
  4. Check off items as you verify them — leave items unchecked if issues were found (note what was fixed in your PR)
  5. Add your general comments at the bottom before closing

1. Prose / 文本翻译

  • Accuracy — Chinese text faithfully conveys the meaning of the English
  • Fluency — Chinese reads naturally, not like machine translation
  • Consistency — Key terms are translated consistently throughout
  • Completeness — No content is missing or left untranslated

2. Mathematical Content / 数学内容

  • LaTeX formulas render correctly
  • Mathematical notation matches the English source
  • Variable names and symbols are consistent with surrounding text
  • Inline vs. display math used appropriately

3. Figures & Images / 图表

  • All figures render correctly
  • Axis labels, titles, and legends are translated where appropriate
  • Figure captions are translated accurately
  • Alt text is translated (if present)

4. Code & Comments / 代码与注释

  • Code blocks execute without errors
  • Code comments are translated accurately
  • Code output descriptions are translated
  • Variable names in prose match the code (not translated where they shouldn't be)

5. Links & References / 链接与引用

  • Internal cross-references work correctly
  • External links are valid
  • Bibliographic references are intact

6. Formatting & Structure / 格式与结构

  • Headings and section structure match the English source
  • Admonitions (notes, warnings, tips) render correctly
  • Lists, tables, and blockquotes are properly formatted
  • No broken MyST/Sphinx directives

7. Language Edge Cases / 语言特殊情况

  • Proper nouns (names, institutions, software) handled correctly
  • Numbers and units formatted appropriately
  • Punctuation uses correct Chinese marks(,。;:!?)not English ones
  • No stray English words that should be translated
  • Technical terms appropriately translated or correctly left in English

General Comments on Translation Quality

Please share your overall impressions of the translation. This feedback will be used to improve our automated translation tooling. Consider:

  • How natural does the Chinese read overall?
  • Were there any recurring patterns of errors?
  • Any terms or phrases that were particularly well or poorly translated?
  • Any suggestions for the translation glossary?

Comments:


Summary

  • Overall quality: ⬜ Excellent / ⬜ Good / ⬜ Needs revision / ⬜ Major rework needed
  • PR with fixes: #___

Metadata

Metadata

Assignees

No one assigned

    Labels

    translation-reviewReview of lecture translation quality

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions