element descriptions should consist exclusively of some brief text that tells a person more than what they can learn from the title
knowledge about whether the term is multi-valued or any example values should be broken out into the appropriate LinkML attributes, like multivalued and examples. This avoids current or future contradictions within the schema.
descriptions should follow a uniform style. Currently there is a mix of styles like:
imperative
interrogative
purely definitional
there is no need to repeat the the name of the term being defined
there is no need to reiterate that the term is a field, slot, variable, or that it "describes" some quality
if it is beneficial to attribute the description, additional LinkML slots like XXX can be used.
bad examples
"pH is a term that describes whether a solution is more acid (maximally 0) or more basic (maximally 14)"
better: "The hydrogen potential of an aqueous solution. Used to distinguish acids from bases."
descriptions should consist exclusively of some brief text that tells a person more than what they can learn from the titlemultivaluedandexamples. This avoids current or future contradictions within the schema.descriptions should follow a uniform style. Currently there is a mix of styles like:nameof the term being definedbad examples