Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

fix: proper documentation forauto inshards docs#3527

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Draft
ilan-gold wants to merge3 commits intozarr-developers:main
base:main
Choose a base branch
Loading
fromilan-gold:ig/fix_shards_docs

Conversation

@ilan-gold
Copy link
Contributor

@ilan-goldilan-gold commentedOct 15, 2025
edited
Loading

This PR adds a model for how we might start adding these sorts of types, by applying the paradigm toshards 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:

  • 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 indocs/user-guide/*.md
  • Changes documented as a new file inchanges/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@github-actionsgithub-actionsbot added the needs release notesAutomatically applied to PRs which haven't added release notes labelOct 15, 2025
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@ilan-gold

[8]ページ先頭

©2009-2025 Movatter.jp