Convert rst double-backtick docstring markup to markdown - #4193
Merged
Conversation
jhamman
commented
Jul 28, 2026
| @@ -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. | |||
Member
Author
There was a problem hiding this comment.
reminder to update PR number
d-v-b
approved these changes
Jul 28, 2026
Contributor
|
thanks joe! |
Contributor
|
i think you need to apply the symmetric transformation to the routines in |
jhamman
force-pushed
the
feature/markdown-docstrings
branch
from
July 30, 2026 04:51
626e63c to
2509d00
Compare
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>
jhamman
force-pushed
the
feature/markdown-docstrings
branch
from
July 30, 2026 04:51
2509d00 to
b148726
Compare
d-v-b
enabled auto-merge (squash)
August 3, 2026 17:01
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4193 +/- ##
=======================================
Coverage 93.99% 93.99%
=======================================
Files 91 91
Lines 12795 12795
=======================================
Hits 12027 12027
Misses 768 768
🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Docstring-only change: replace
code(reStructuredText) withcode(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
TODO
docs/user-guide/*.mdchanges/