Add Type Hints section to More Language Features lecture by mmcky · Pull Request #488 · QuantEcon/lecture-python-programming

mmcky · 2026-03-23T00:16:37Z

Summary

Adds a compact new section on Python type hints to the More Language Features lecture, placed between the Operators section and Decorators.

Content

Basic Syntax: annotating function parameters, return types, and variables
Common Types: table of built-in types plus container type syntax
Hints Do Not Enforce Types: demonstration that Python ignores type hints at runtime
Why Use Type Hints: readability, IDE support, error checking tools, LLM-generated code
Type Hints in Scientific Python: connection to JAX/Numba and JIT compilation concepts

Design Decisions

Kept minimal (~100 lines) to avoid overwhelming new Python programmers
Added as a section (not a full lecture), per discussion in the issue
Cross-references the existing dynamic typing discussion in need_for_speed
All code cells execute successfully in the Jupyter Book build

Closes #343

Adds a compact section on Python type hints to the python_advanced_features lecture, covering: - Basic syntax (function parameters, return types, variable annotations) - Common built-in types and container type syntax - Demonstration that hints are not enforced at runtime - Why type hints matter (readability, IDE support, error checking, LLM code) - Connection to scientific Python and JIT compilation Closes #343

github-actions · 2026-03-23T00:24:38Z

🚀 Deployed on https://69c0b5ca865a3fc2d5482620--epic-agnesi-957267.netlify.app

mmcky · 2026-03-23T00:56:14Z

@jstac I think this is a nice (small) addition that captures the essence of your excellent comment in #343

jstac · 2026-03-23T01:43:54Z

Very nice :-)

BTW, I remember that last year the PRs were listing changed lectures (links to deployment lectures), making it easier to click through and see changes. Is that infrastructure still available?

mmcky · 2026-03-23T01:54:39Z

nice catch @jstac -- it looks like I haven't updated lecture-python-programming.

QuantEcon/meta#296

Direct lecture linking is in python.quantecon.org repo (but not here).

I'll roll out our quantecon/actions/netlify-preview action across the board.

LGTM.

mmcky · 2026-03-23T01:55:25Z

do a pass of the quantecon style guide before merging. (@mmcky)

jstac · 2026-03-23T02:04:08Z

Thanks @mmcky

Is there a way to automate this across the repos, along with updates to styles etc?

Is it worth revisiting the one-big-repo idea?

Just tossing ideas around -- I don't really know the upsides and downsides...

mmcky · 2026-03-23T02:05:32Z

Thanks @mmcky

Is there a way to automate this across the repos, along with updates to styles etc?

Is it worth revisiting the one-big-repo idea?

Just tossing ideas around -- I don't really know the upsides and downsides...

thanks @jstac

I am actually running this PR over https://github.com/quantEcon/action-style-guide right now as a test case.

This automation is still in work -- too much noise (I don't want to add noise -- only value).

Lowercase section headings to capitalize only the first word and proper nouns (e.g., Python), per QuantEcon style rules.

Apply sentence case to all section headings (##, ###, ####) across the entire lecture, not just the new Type Hints section. Only the first word and proper nouns (e.g., Python) are capitalized.

mmcky · 2026-03-23T02:25:25Z

Applied qe-writing-006 (sentence-case headings) across the entire lecture — not just the new Type Hints section. Fixed 14 headings total to capitalize only the first word and proper nouns.

Change bold to italic for emphasis (not definitions): - 'skip it on first pass' (pre-existing) - 'ignored by the Python interpreter at runtime' - 'not enforced' - 'clarity and tooling support'

mmcky · 2026-03-23T02:37:05Z

Style fix (qe-writing-005): Changed bold to italic in 4 places where formatting was used for emphasis rather than definitions:

L25: skip it on first pass (pre-existing)
Note box: ignored by the Python interpreter at runtime
Type hints section: not enforced
Type hints section: clarity and tooling support

Bold remains for the **type hints** definition and the numbered list labels (**Readability**, **Editor support**, etc.) which serve as definition-style labels.

mmcky · 2026-03-23T02:38:57Z

@jstac this looks good to me now. I'll merge this. thanks for casting an eye over it.

jstac · 2026-03-23T02:48:08Z

Thanks @mmcky, looks good.

Copilot

Pull request overview

Adds a new, compact “Type hints” section to the More Language Features lecture, positioned between the */** operators content and the decorators section, to introduce annotations and their practical benefits in scientific Python.

Changes:

Introduces a new “Type hints” section covering syntax, common types, and runtime behavior.
Adds a short discussion of why type hints are useful (readability, tooling, static checkers, LLM-generated code).
Updates various headings/emphasis around the insertion point (capitalization/styling).

lectures/python_advanced_features.md

mmcky · 2026-03-23T05:49:15Z

\translate-resync

mmcky · 2026-03-23T05:51:10Z

✅ Translation sync completed (zh-cn)

Target repo: QuantEcon/lecture-python-programming.zh-cn
Translation PR: QuantEcon/lecture-python-programming.zh-cn#2
Files synced (1):

lectures/python_advanced_features.md

mmcky · 2026-03-23T05:53:13Z

✅ Translation sync completed (fa)

Target repo: QuantEcon/lecture-python-programming.fa
Translation PR: QuantEcon/lecture-python-programming.fa#69
Files synced (1):

lectures/python_advanced_features.md

mmcky added 2 commits March 23, 2026 11:12

Minor: join note text into single paragraph line

f4ac10d

github-actions bot temporarily deployed to pull request March 23, 2026 00:30 Inactive

mmcky requested a review from jstac March 23, 2026 00:56

mmcky added 2 commits March 23, 2026 13:23

Fix section heading capitalization per qe-writing-006

6c745ac

Lowercase section headings to capitalize only the first word and proper nouns (e.g., Python), per QuantEcon style rules.

Fix heading capitalization lecture-wide per qe-writing-006

e868fbb

Apply sentence case to all section headings (##, ###, ####) across the entire lecture, not just the new Type Hints section. Only the first word and proper nouns (e.g., Python) are capitalized.

github-actions bot temporarily deployed to pull request March 23, 2026 02:33 Inactive

Fix bold/italic usage per qe-writing-005 style rule

de3b830

Change bold to italic for emphasis (not definitions): - 'skip it on first pass' (pre-existing) - 'ignored by the Python interpreter at runtime' - 'not enforced' - 'clarity and tooling support'

github-actions bot temporarily deployed to pull request March 23, 2026 02:44 Inactive

mmcky requested a review from Copilot March 23, 2026 02:48

Copilot started reviewing on behalf of mmcky March 23, 2026 02:48 View session

Copilot AI reviewed Mar 23, 2026

View reviewed changes

lectures/python_advanced_features.md Outdated Show resolved Hide resolved

lectures/python_advanced_features.md Show resolved Hide resolved

lectures/python_advanced_features.md Show resolved Hide resolved

lectures/python_advanced_features.md Show resolved Hide resolved

Address Copilot review: fix version text and type mismatch example

78e37d1

github-actions bot temporarily deployed to pull request March 23, 2026 03:38 Inactive

mmcky merged commit f791129 into main Mar 23, 2026
5 checks passed

mmcky deleted the add-type-hints-section branch March 23, 2026 04:00

mmcky mentioned this pull request Mar 23, 2026

ci: bump action-translation v0.11.1 → v0.11.2 #489

Merged

mmcky mentioned this pull request Mar 23, 2026

🌐 [translation-sync] Add Type Hints section to More Language Features lecture QuantEcon/lecture-python-programming.zh-cn#2

Open

mmcky mentioned this pull request Mar 23, 2026

🌐 [translation-sync] Add Type Hints section to More Language Features lecture QuantEcon/lecture-python-programming.fa#69

Open

Uh oh!

Conversation

mmcky commented Mar 23, 2026

Summary

Content

Design Decisions

Uh oh!

github-actions bot commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mmcky commented Mar 23, 2026

Uh oh!

jstac commented Mar 23, 2026

Uh oh!

mmcky commented Mar 23, 2026

Uh oh!

mmcky commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jstac commented Mar 23, 2026

Uh oh!

mmcky commented Mar 23, 2026

Uh oh!

mmcky commented Mar 23, 2026

Uh oh!

mmcky commented Mar 23, 2026

Uh oh!

mmcky commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jstac commented Mar 23, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mmcky commented Mar 23, 2026

Uh oh!

mmcky commented Mar 23, 2026

✅ Translation sync completed (zh-cn)

Uh oh!

mmcky commented Mar 23, 2026

✅ Translation sync completed (fa)

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Mar 23, 2026 •

edited

Loading

mmcky commented Mar 23, 2026 •

edited

Loading

mmcky commented Mar 23, 2026 •

edited

Loading