Skip to content

Convert rst double-backtick docstring markup to markdown - #4193

Open
jhamman wants to merge 1 commit into
zarr-developers:mainfrom
jhamman:feature/markdown-docstrings
Open

Convert rst double-backtick docstring markup to markdown#4193
jhamman wants to merge 1 commit into
zarr-developers:mainfrom
jhamman:feature/markdown-docstrings

Conversation

@jhamman

@jhamman jhamman commented Jul 28, 2026

Copy link
Copy Markdown
Member

Summary

Docstring-only change: replace code (reStructuredText) with code (Markdown) in zarr.api.asynchronous, zarr.registry, and zarr.storage._common, matching the repo's mkdocs-based docs.

For reviewers

@d-v-b - this was uncovered when you asked me to go rst->markdown in #4187.

Author attestation

  • I am a human, these are my changes, and I have reviewed and understood every change and can explain why each is correct.

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)

Docstring-only change: replace ``code`` (reStructuredText) with `code`
(Markdown) in zarr.api.asynchronous, zarr.registry, and
zarr.storage._common, matching the repo's mkdocs-based docs.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Comment thread changes/9999.doc.md
@@ -0,0 +1,3 @@
Converted remaining reStructuredText-style double-backtick markup to Markdown
single backticks in the docstrings of `zarr.api.asynchronous`, `zarr.registry`,
and `zarr.storage._common`. No functional changes.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

reminder to update PR number

@d-v-b

d-v-b commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

thanks joe!

@d-v-b

d-v-b commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

i think you need to apply the symmetric transformation to the routines in synchronous.py.

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.

2 participants