about#

  • Series: lecture-python-intro

  • File: lectures/about.md

  • Audit date: 2026-05-28

  • Categories audited: writing, math, code, figures, references, links, admonitions (JAX out of scope)

  • Overall score: 7.7 / 10

  • Priority: LOW

Score breakdown#

Category

Score

One-line note

Writing

8/10

H1 “About These Lectures” Title Case OK; section H2s “About”/“Level”/“Credits” OK; some multi-sentence paragraphs.

Math

N/A

no math content

Code

N/A

no code cells

JAX

out of scope

—

Figures

N/A

no figures

References

N/A

no {cite} citations

Links

7/10

one direct URL to python-programming.quantecon.org/intro.html (line 46) where {doc} link is preferred.

Admonitions

N/A

no admonitions

Issues#

Critical#

None found.

High severity#

None found.

Medium severity#

  • [qe-writing-001] — Multiple multi-sentence paragraphs throughout (e.g. lines 6–8 introductory paragraph, lines 24–27, lines 33–35, 49–51, 55–57). Count: ~5 paragraphs.

  • [qe-link-002] — Cross-series URL written as direct link instead of {doc} reference. Example: lectures/about.md:46 (link to python-programming.quantecon.org/intro.html). Count: 1 occurrence.

Low severity#

None found.

Strengths#

  • Headings comply with qe-writing-006.

  • Clear, friendly prose.

  • Trailing whitespace appears on a few lines but does not affect rendering.