Skip to content

Tidy up schema titles and descriptions#45

Merged
joshmoore merged 1 commit intoome:mainfrom
dstansby:title-desc-tidy
Jan 13, 2026
Merged

Tidy up schema titles and descriptions#45
joshmoore merged 1 commit intoome:mainfrom
dstansby:title-desc-tidy

Conversation

@dstansby
Copy link
Copy Markdown
Contributor

@dstansby dstansby commented Jan 9, 2026

This tidies up the title and description fields in the schemas to make them consistent. In particular:

I'm hoping this is a good start to improving the schema documentation website by making the titles shorter and descriptions more descriptive.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 9, 2026

Automated Review URLs

@jo-mueller
Copy link
Copy Markdown
Contributor

jo-mueller commented Jan 9, 2026

@dstansby +1 for adding more details to these useful fields. I feel the descriptions could be a bit expanded? In the simplest sense, the description could just be the first sentence from the spec text itself, i.e.:

  • axes: "axes" describes the dimensions of a physical coordinate space
  • bioformats2raw: bioformats2raw.layout metadata identifies a group which implicitly describes a series of images
  • labels: In OME-Zarr, Zarr arrays representing pixel-annotation data are stored in a group called "labels".
  • etc

if that makes sense to you? For some of the fields, there's obviously not that much to be written, though.

@joshmoore
Copy link
Copy Markdown
Member

Thanks, @dstansby.

@joshmoore joshmoore merged commit dbd5b74 into ome:main Jan 13, 2026
4 checks passed
@dstansby dstansby deleted the title-desc-tidy branch January 13, 2026 11:49
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.

3 participants