Skip to content

Improve Typing Guide: Tips and Resources #1166

Open

Description

@TimMonko

This is a good start. I don't want to delay this documentation section longer, maybe as a follow up what I would suggest is showing concrete, working code snippets. We shouldn't be re-writing the typing documentation but something immediate for newcomers to get a grasp on would simplify the navigation to other documentation pages.

Originally posted by @jacopoabramo in #1135 (review)

Jacopo has some great ideas here, we're going to merge and make time for follow-up!

Activity

  1. zelihaguven commented on Oct 20, 2026

    @zelihaguven

    Hi! I'd like to take this. Plan: extend docs/developers/contributing/typing.md (added in #1135) with a short tips section with code snippets for common patterns (e.g. TYPE_CHECKING imports, Optional/union types, numpy.typing arrays, protocols) and a curated resources list (typing docs, mypy docs, NumPy typing). I'll open a PR soon unless someone's already on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions