Better differentiate between "array" and "Zarr array" in the spec
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 171
- Forks
- 75
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 20
Description
As "array" is a reserved word in JSON, we could make an effort to always directly qualify Zarr arrays and Zarr groups in the spec.
This could lead to some weird-ish, but clearer phrases like
Each image is a Zarr group of other groups and arrays. would become Each image is a Zarr group of other Zarr groups and Zarr arrays.
One ambiguous example:
The labels group is a container which holds an array of labels to make the objects easily discoverable
Is referring to a Zarr array, but that is not immediately clear.
We could also add one paragraph about the use of JSON terminology to the "Document conventions" section
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the spec's "Document conventions" section and searching the specification for unqualified uses of "array" and "group". Done means Zarr arrays and Zarr groups are consistently distinguished from JSON terminology, including the ambiguous labels example, with the proposed terminology guidance added.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100