fix: proper documentation for auto
in shards
docs
#3527
+23
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a model for how we might start adding these sorts of types, by applying the paradigm to
shards
increate_array
. We now have atypes.md
that contains type hints. I'm personally not 100% if exposing a path tocore
is kosher, but also in theory, people should be putting typing imports behind aTYPE_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:
docs/user-guide/*.md
changes/