DiamondLightSource / DiamondLightSource/ulims-json-schemas

experiment definitions should have a description

Open
#46 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Dockerfile
Stars
3
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Consumers of schema will probably want to be able to explain what it is that they are schema-ing. For an instrument that has a few different types of data collection, a UI will want to explain to the user what this type of data collection is in language specific to that instrument.

It looks as though a schema can have a top-level `description` field, so I propose we use that.

Perhaps these descriptions should even be mandatory....

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.