Skip to content

docs(examples): add type hints to things examples#2685

Closed
l46983284-cpu wants to merge 1 commit into
falconry:masterfrom
l46983284-cpu:contrib/wave1-falcon
Closed

docs(examples): add type hints to things examples#2685
l46983284-cpu wants to merge 1 commit into
falconry:masterfrom
l46983284-cpu:contrib/wave1-falcon

Conversation

@l46983284-cpu

Copy link
Copy Markdown
Contributor

Summary

Focused first slice of type hints for tutorials/examples:

  • annotate examples/things.py (WSGI)
  • annotate examples/things_asgi.py (ASGI)

This intentionally does not rewrite the whole docs tree — just a small, reviewable starting point.

Test plan

  • python -m py_compile on both example files
  • CI / docs examples still import cleanly

Refs #1820

@l46983284-cpu

Copy link
Copy Markdown
Contributor Author

Small docs-only follow-up for the things / things_asgi examples (type hints + ruff import order).

This is my first contribution here — if GitHub is holding workflow runs for first-time contributors, please approve them when convenient. Happy to adjust if the examples style guide prefers a different annotation shape.

@codecov

codecov Bot commented Jul 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (6a49881) to head (47626d2).

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #2685   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           64        64           
  Lines         7985      7985           
  Branches      1103      1103           
=========================================
  Hits          7985      7985           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@l46983284-cpu
l46983284-cpu force-pushed the contrib/wave1-falcon branch from 47626d2 to d0715e9 Compare July 14, 2026 15:29
- style(examples): fix ruff import sorting in things examples

Signed-off-by: Alex Chen <l46983284@gmail.com>
@l46983284-cpu
l46983284-cpu force-pushed the contrib/wave1-falcon branch from d0715e9 to afdbab0 Compare July 18, 2026 08:42
@l46983284-cpu

Copy link
Copy Markdown
Contributor Author

Rebased onto current master. Product unit is unchanged: type hints on examples/things.py and examples/things_asgi.py only.

Local: python3 -m py_compile on both example files.

@vytas7

vytas7 commented Jul 21, 2026

Copy link
Copy Markdown
Member

Hello! It seems you (or your agent) removed our PR template. This is not a good idea for new contributors; you should go through the points, and check what's applicable.

I am going to close this PR, but feel free to open a new one (this time paying heed to our contribution guidelines). Thanks!

@vytas7 vytas7 closed this Jul 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants