Skip to content

Conversation

ilan-gold
Copy link
Contributor

@ilan-gold ilan-gold commented Oct 15, 2025

This PR adds a model for how we might start adding these sorts of types, by applying the paradigm to shards in create_array. We now have a types.md that contains type hints. I'm personally not 100% if exposing a path to core is kosher, but also in theory, people should be putting typing imports behind a TYPE_CHECKING block so that should be ok? I'm just worried about people importing from these paths, and then those paths breaking (see #3355).

I would thus make it super clear that imports of these types are not guaranteed until merging #3355 and then we can fix these two issues in parallel in theory.

TODO:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/user-guide/*.md
  • Changes documented as a new file in changes/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@github-actions github-actions bot added the needs release notes Automatically applied to PRs which haven't added release notes label Oct 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs release notes Automatically applied to PRs which haven't added release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant