Appendix — feedback to the style guide & action-style-guide#

This audit doesn’t just score lectures — it also feeds back into the tooling and conventions it scores against. This page summarises that feedback. The source material (issue bodies, ready-to-merge rule entries) lives in the repo under contributions/.

How the pieces fit#

The QuantEcon manual style guide is the human-readable source of conventions.
action-style-guide is the tool that enforces them — a registry of qe-* rules checked at PR time. This audit scores lectures against that registry (see the scoring spec).
Where the audit found a convention in the manual that isn’t yet a coded rule, or a way to make the tool catch more, faster, it became feedback. Four issues capture it.

Four issues opened#

Issue	What it proposes
#18 — 7 new style rules	Encode 7 conventions the manual documents but the registry is missing (see table below).
#19 — Phase 4.3 acceleration	Extend the planned deterministic-checker scope from ~13 to 22 rules, prioritised by audit-measured frequency, with this corpus as regression-test data.
#20 — bulk-audit mode	A design discussion: should cross-series scoring / synthesis (what produced this report) live inside `action-style-guide`, a sibling tool, or stay ad-hoc?
#21 — corpus offer	Offers this 299-lecture labelled corpus as test / evaluation fixtures for the tool. No action required.

Proposed new rules (issue #18)#

Seven conventions documented in the manual but not yet in the registry. They appear throughout this report tagged (proposed). The five strong-evidence rules are recommended for adoption; the last two are weaker-evidence and may be deferred.

Proposed ID	Convention	Corpus evidence
`qe-writing-009`	Write “IID”, not “i.i.d.” / “iid”	~30 lectures
`qe-math-010`	`\mathbb{P}` / `\mathbb{E}` / `\mathbb{V}` (with braces) for probability, expectation, variance	~60 lectures
`qe-math-011`	Plain letters for distribution names (`N`, not `\mathcal{N}`)	~30 lectures
`qe-math-012`	`\cdot` or juxtaposition for multiplication — never `*`	~5 lectures
`qe-math-013`	Reference equations via {eq}`label`	moderate
`qe-math-014` (weaker)	Braces `\{…\}` for events, parentheses `(…)` for sets under `\mathbb{P}`	limited
`qe-math-015` (weaker)	Lowercase for densities/PMFs, uppercase for CDFs	limited

Ready-to-merge rule entries for each are in contributions/rule-drafts/.

Direct feedback to a lecture repo#

Two findings are build-breaking and were flagged for lecture-python.myst regardless of the tooling discussion (also on the front page):

divergence_measures.md:134 — \begin{align} inside $$ (breaks the PDF build).
cross_product_trick.md:133 — broken {eq} reference.

Status#

All four issues are open. Since they were filed, the broader style-guide program (coordinated in QuantEcon/project-style-guide, a private planning hub) has set a new direction: rules are being consolidated into a single QuantEcon/style-guide rule database, and action-style-guide is slated to be split and retired. Under that direction the rule-drafts/ here serve as transcription inputs for the consolidated database rather than a PR against action-style-guide. See contributions/README.md for the current status.