search

poseidon-framework / poseidon-schema

An archaeogenetic genotype data organisation file format
0 stars 1 forks source link

Rephrasing #63

Closed nevrome closed 1 year ago

nevrome commented 1 year ago

I realized that the schema text is a bit chaotic. I think we can rephrase it a bit to make it clearer and more uniform. A version change is imho not required.

nevrome commented 1 year ago

For the review I suggest you don't look so much at the line-wise differences, because it's confusing in this case, but focus on the new document version here: https://github.com/poseidon-framework/poseidon-schema/blob/rephrasing2.7.1/README.md

TCLamnidis commented 1 year ago

I have often seen the validation keywords put in all caps (e.g. A package therefore MUST contain:). I generally find that this system makes it clearer to a reader that the specific words used matter and it's not just about what sounds nicer.