Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: ZIP-related tweaks #1641

Merged
merged 6 commits into from Feb 15, 2024
Merged

docs: ZIP-related tweaks #1641

merged 6 commits into from Feb 15, 2024

Conversation

d-v-b
Copy link
Contributor

@d-v-b d-v-b commented Jan 29, 2024

Following up on #1615, this PR changes instances of "zip file" to "ZIP archive", "zipped zarr" to "ZIP-archived Zarr array or group" (following the conventional description of ZIP archives as such). I also added an explicit statement about when caching may be useful in the s3 + zip example. There's also some minor stylistic changes to the content added in #1615

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/tutorial.rst
  • Changes documented in docs/release.rst
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

@d-v-b
Copy link
Contributor Author

d-v-b commented Jan 29, 2024

given the changes I made, the CI failure is interesting but probably not for this PR

…st release notes, and fix markup in past release notes
@d-v-b
Copy link
Contributor Author

d-v-b commented Jan 29, 2024

I also fixed some markup errors and typos in the release notes.

@d-v-b d-v-b requested a review from jhamman February 14, 2024 20:39
@d-v-b d-v-b requested a review from joshmoore February 15, 2024 09:37
@d-v-b d-v-b added this to the 2.17.1 milestone Feb 15, 2024
Copy link
Member

@joshmoore joshmoore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @d-v-b!

@joshmoore joshmoore merged commit 3db4176 into main Feb 15, 2024
20 checks passed
@joshmoore joshmoore deleted the s3_zip_docs branch February 15, 2024 09:54
@MSanKeys963 MSanKeys963 mentioned this pull request Feb 20, 2024
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants