Skip to content

Add documentations for developers on how this package supports static typing. - #953

Merged
junkmd merged 5 commits into
enthought:mainfrom
junkmd:typing_docs
Oct 3, 2026
Merged

junkmd merged 5 commits into
enthought:mainfrom
junkmd:typing_docs

Conversation

@junkmd

@junkmd junkmd commented Oct 3, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • CONTRIBUTING.md
    Added details about the CI pipeline: it now runs static type checking (mypy, pyright, ty) in addition to runtime tests, and clarifies that urgent releases may proceed even if type checks fail.
  • docs/source/index.rst
    Added a reference to the new type_checking.rst section in the documentation index.
  • docs/source/type_checking.rst
    Introduced a new documentation page that explains how comtypes generates type hints, provides a detailed example using Scripting.Dictionary, and discusses limitations of static type analysis for COM pointers.

@junkmd junkmd added this to the 1.5.0 / Support Python 3.15 milestone Oct 3, 2026
@junkmd junkmd added shared_info use cases, tips and troubleshoots typing related to Python static typing system labels Oct 3, 2026
@junkmd junkmd linked an issue Oct 3, 2026 that may be closed by this pull request
@codecov-commenter

codecov-commenter commented Oct 3, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.98%. Comparing base (715ab82) to head (4dcfcc2).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #953   +/-   ##
=======================================
  Coverage   88.98%   88.98%           
=======================================
  Files         140      140           
  Lines       13678    13678           
=======================================
  Hits        12171    12171           
  Misses       1507     1507           

☔ 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.

@junkmd
junkmd merged commit 3b9f5ff into enthought:main Oct 3, 2026
229 of 257 checks passed
@junkmd
junkmd deleted the typing_docs branch October 3, 2026 06:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

shared_info use cases, tips and troubleshoots typing related to Python static typing system

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Introduce CI type-checking

2 participants