Skip to content

Conversation

@maxrjones
Copy link
Member

@maxrjones maxrjones commented Oct 23, 2025

This PR aims to address #3542.

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 23, 2025
@maxrjones
Copy link
Member Author

I'm not able to request reviews from you, but FYI @ilan-gold @ianhi

@maxrjones maxrjones removed the needs release notes Automatically applied to PRs which haven't added release notes label Oct 23, 2025
@ilan-gold
Copy link
Contributor

ilan-gold commented Oct 24, 2025

Commented here @maxrjones but I think the check (in ci) should be on the objects.inv file. I don't think breaking http links is a python package's problem (personally, maybe unpopular since I'm very intersphinxy), but breaking intersphinx links is probably bad.

@maxrjones
Copy link
Member Author

Commented here @maxrjones but I think the check (in ci) should be on the objects.inv file. I don't think breaking http links is a python package's problem (personally, maybe unpopular since I'm very intersphinxy), but breaking intersphinx links is probably bad.

Can you please provide an example of an intersphinx link that is still broken following the changes in this PR?

@github-actions github-actions bot added the needs release notes Automatically applied to PRs which haven't added release notes label Oct 24, 2025
@maxrjones maxrjones mentioned this pull request Oct 24, 2025
25 tasks
@ilan-gold
Copy link
Contributor

ilan-gold commented Oct 24, 2025

Can you please provide an example of an intersphinx link that is still broken following the changes in this PR?

Apologies, I should have been clearer. I wasn't commenting on how well this fixes things, more just responding to what Davis said about checking URLs directly. I think the unit of interest shouldn't be the actual URLs but the intersphinix lookup i.e., the later should be checked. I try to avoid using URLs for exactly that reason - they can change but intersphinx allows us to keep the location in the reference the same over that.

That being, here's what I got locally against https://zarr--3544.org.readthedocs.build/en/3544/:

/Users/ilangold/Projects/Theis/arrayloaders/docs/index.md:22: WARNING: undefined label: 'zarr:user-guide-sharding' [ref.ref]
/Users/ilangold/Projects/Theis/arrayloaders/docs/index.md:60: WARNING: py:mod reference target not found: zarr [ref.mod]
/Users/ilangold/Projects/Theis/arrayloaders/docs/index.md:60: WARNING: py:mod reference target not found: zarr [ref.mod]
/Users/ilangold/Projects/Theis/arrayloaders/docs/zarr-configuration.md:10: WARNING: py:mod reference target not found: zarr [ref.mod]
/Users/ilangold/Projects/Theis/arrayloaders/docs/zarr-configuration.md:35: WARNING: unknown document: 'zarr:user-guide/config' [ref.doc]

UPDATE: tried remotely as well: https://app.readthedocs.org/projects/annbatch/builds/30070579/

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.

2 participants