Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document additional static type checking without a typing module #805

Merged
merged 1 commit into from
Mar 17, 2025

Conversation

Josverl
Copy link
Owner

@Josverl Josverl commented Mar 17, 2025

Fixes #766

Add documentation for static type checking without a typing module.

  • docs/22_static_type_checking.md:

    • Add a new section explaining the alternative method using TYPE_CHECKING and conditional imports.
    • Include a code example demonstrating how to use TYPE_CHECKING and conditional imports to perform static type checking without a typing module.
  • docs/index.md:

    • Update the table of contents to include a link to the new section in docs/22_static_type_checking.md.

For more details, open the Copilot Workspace session.

Fixes #766

Add documentation for static type checking without a typing module.

* **`docs/22_static_type_checking.md`**:
  - Add a new section explaining the alternative method using `TYPE_CHECKING` and conditional imports.
  - Include a code example demonstrating how to use `TYPE_CHECKING` and conditional imports to perform static type checking without a typing module.

* **`docs/index.md`**:
  - Update the table of contents to include a link to the new section in `docs/22_static_type_checking.md`.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/Josverl/micropython-stubs/issues/766?shareId=XXXX-XXXX-XXXX-XXXX).
@Josverl Josverl merged commit b40a495 into main Mar 17, 2025
1 check failed
@Josverl Josverl deleted the document-static-type-checking branch March 17, 2025 12:23
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.

Document additional static type checking without a typing module
1 participant