short_path#

  • Series: lecture-python-intro

  • File: lectures/short_path.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

9/10

Clean H1/H2/H3 conventions; one-sentence paragraphs throughout.

Math

9/10

Simple notation; no transpose; uses {math} directives correctly.

Code

8/10

Standard numpy only; no Greek-letter variables.

JAX

out of scope

—

Figures

5/10

4 {figure} directives (lines 57, 78, 84, 96) — all reference static PNGs (qe-fig-002 concern: could be code-generated); none have :name: field for cross-referencing (qe-fig-005).

References

N/A

no {cite} citations

Links

N/A

no quantecon cross-series links

Admonitions

9/10

1 solution gated, dropdown, exercise-linked.

Issues#

Critical#

None found.

High severity#

None found.

Medium severity#

  • [qe-fig-005] — All 4 {figure} directives lack :name: field for cross-referencing. Examples: lines 57, 78, 84, 96. Count: 4 occurrences.

  • [qe-fig-002] — Figures use static PNGs (/_static/lecture_specific/short_path/graph*.png) where graphs could potentially be generated by code (e.g., via networkx). Count: 4 static images.

Low severity#

  • W1 — Occasional two-sentence paragraphs (e.g. lines 140–141).

Strengths#

  • Section headings sentence-case (W3 compliant).

  • Equation labelling via {math} with :label: form.

  • Clean prose; bold for definitions (“Bellman equation”, “distance matrix”).

  • Solution gated, dropdown, linked.