troubleshooting#

  • Series: lecture-python.myst

  • File: lectures/troubleshooting.md

  • Audit date: 2026-05-28

  • Categories audited: writing, math, code, figures, references, links, admonitions

  • Overall score: 9.0 / 10

  • Priority: NONE

Score breakdown#

Category

Score

One-line note

Writing

7/10

Section headings use Title Case instead of sentence case.

Math

N/A

no math content

Code

10/10

Clean code conventions.

JAX

out of scope

not a JAX lecture

Figures

10/10

Figures follow conventions.

References

N/A

No citations.

Links

9/10

1 direct URL to another QuantEcon series — should use {doc} link.

Admonitions

N/A

No admonitions.

Issues#

Critical#

None found.

High severity#

None found.

Medium severity#

  • [qe-writing-006] — Section headings use Title Case instead of sentence case. Examples: line 29 ## Fixing Your Local Environment, line 65 ## Reporting an Issue. Count: 2 occurrences.

  • [qe-link-002] — 1 direct URL to another QuantEcon series — should use {doc} link. Example: line 36.

Low severity#

None found.

Strengths#

  • Short, clear one-sentence paragraphs throughout.