reference to issue #237

GitHub Copilot Review Instructions for Subtitle Capitalization Changes

Overview

Review a large-scale change that converts all subtitles (headings marked with ##, ###, ####) in lecture markdown files from title case to sentence case, where only the first letter of the first word should be capitalized.

Note orth_proj.md is not changed on purpose. So you can skipped this one

What to Check

1. Verify Sentence Case Conversion

• ✅ Correct: ## The density case, ### Computing stationary densities, ## A model with restructuring
• ❌ Incorrect: ## The Density Case, ### Computing Stationary Densities, ## A Model with Restructuring

2. Ensure Proper Names Remain Capitalized

Check that the following proper names maintain their capitalization:

• Economic theorists: Bellman, Nash, Ramsey, Lucas, Markov, Kalman, Von Neumann, Barro, Hall, Friedman, Walras, Arrow, Pareto, Phillips, Euler, Lagrange, Hamilton, Cobb, Douglas, Solow, Swan, Rosen, Topel, Modigliani, Miller, Stackelberg, Ponzi, Ricardian
• Mathematical/Statistical names: Gaussian, Newton, Bayes, Taylor
• Example: ## The Ramsey problem ✅ (Ramsey is a proper name)

3. Preserve Technical Terms and Acronyms

Verify these remain fully capitalized:

• Acronyms: ARMA, BEGS, AMSS, CRRA, LQ, DP, DPs, IID, GARCH, VAR, OLS, MLE, GMM
• Technical notation: AR(1), MA(1), ARMA(p,q)
• Programming terms: Python, Jupyter, NumPy, SciPy
• Example: ### ARMA processes ✅, ## Discrete DPs ✅

4. Special Markdown Syntax Preservation

Ensure MyST markdown index directives are handled correctly:

• The display text should follow sentence case
• The index entry can remain as needed
• Example: ### {index}\Spectral analysis <single: Spectral Analysis>`` ✅
  • Display text "Spectral analysis" is sentence case
  • Index entry "Spectral Analysis" preserved as is

5. Check for Consistency Issues

Look for:

• Mixed patterns: Some headings fixed, others missed in the same file
• Over-correction: Words that should remain capitalized but were lowercased
  • Articles at the beginning should be lowercase: ## A dead end ✅
  • But not: ## a dead end ❌
• Under-correction: Title case patterns that were missed
  • Look for patterns like ## Word Word where the second word isn't a proper name

6. Verify No Code Blocks Were Modified

Ensure changes were NOT made to:

• Python comments inside code blocks (even if they contain # or ##)
• Code cell metadata
• YAML frontmatter
• Example - this should NOT be changed:

  # This is a Python comment
  ## This is also a Python comment

7. Edge Cases to Verify

• Compound terms: ## Roll-over risk ✅ (not "Roll-Over Risk")
• Numbers: ## Model 1 (complete markets) ✅
• Colons: ## Appendix: algorithms ✅ (word after colon follows same rule)
• Parenthetical phrases: ## One- and two-period bonds but no restructuring ✅

Specific Patterns to Flag as Issues

1. Title Case Remnants: Any heading where multiple words are capitalized (unless proper names/acronyms)

   • Flag: ## Public Finance Questions
   • Should be: ## Public finance questions

2. Over-lowercase: Proper names or acronyms that were incorrectly lowercased

   • Flag: ## The ramsey problem
   • Should be: ## The Ramsey problem

3. Inconsistent Treatment: Same term treated differently in different places

   • If "Gaussian" is capitalized in one heading but not another

4. Broken Markdown: Any heading that might have been corrupted during editing

   • Missing spaces, broken MyST syntax, etc.

Files to Pay Special Attention To

Focus extra attention on these files which had many changes:

• hs_recursive_models.md (42+ subtitle changes)
• opt_tax_recur.md (26+ subtitle changes)
• discrete_dp.md (24+ subtitle changes)
• dyn_stack.md (23+ subtitle changes)
• Files with MyST index directives: arma.md

Expected Outcome

All 54 lecture markdown files should have:

• Consistent sentence case for all subtitles
• Proper preservation of proper names, technical terms, and acronyms
• No modifications to code blocks or non-heading content
• Maintained markdown syntax integrity

Review Command Suggestions

# Check for remaining title case issues
grep -r "^##\+ [A-Z][a-z]* [A-Z]" lectures/*.md

# Verify proper names are preserved
grep -r "^##.*[Rr]amsey" lectures/*.md

# Check for over-correction
grep -r "^## [a-z]" lectures/*.md  # Should not start with lowercase

# Verify no code blocks were changed
git diff --word-diff=color lectures/*.md | grep -A2 -B2 "```"

Summary of Changes

• Total files: 54 lecture markdown files
• Files modified: 51 files
• Files unchanged: 3 files (intro.md, markov_jump_lq.md, status.md, zreferences.md)
• Branch name: fix-lecture-subtitle-capitalization

Quick Validation Checklist

• All headings use sentence case (only first word capitalized)
• Proper names remain capitalized
• Technical acronyms remain uppercase
• No code blocks were modified
• MyST syntax is preserved
• No broken markdown formatting
• Consistent treatment across all files