Document StoreLike values in user guide #3480
Merged
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.
Closes #3303
Documents valid values of
StoreLike
in the user guide, and links to this common location from docstrings. This fixes inconsistencies with howStoreLike
is described, see corresponding issue. This is based on the handling ofStoreLike
byzarr.storage._common.make_store
.To link from the docstrings, I had to enable the
autoref
plugin which is recommended in the mkdocstrings documentation. I added a unique markdown anchor for this section in the user guide#user-guide-store-like
to ensure all links go to the correct location. Without this (using the auto-generated heading links alone), would mean that any other doc using a 'StoreLike' heading would break these links.I added examples for all the different values except:
dict[str, Buffer]
andFSMap
. Happy to add examples to this PR if people have suggestions.TODO:
docs/user-guide/*.md
changes/