dandi-schema readme edit

[melster1010]

Edit readme for stylesheet compliance/grammar/clarity/consistency.

[codecov]

Codecov Report

Base: 96.61% // Head: 96.61% // No change to project coverage 👍

Coverage data is based on head (caa4ef2) compared to base (6e44105).
Patch has no changes to coverable lines.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #152   +/-   ##
=======================================
  Coverage   96.61%   96.61%           
=======================================
  Files          16       16           
  Lines        1623     1623           
=======================================
  Hits         1568     1568           
  Misses         55       55           

Flag	Coverage Δ
unittests	96.61% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[waxlamp]

Text looks good. My suggestions are mostly to do with formatting/style.

[waxlamp]

Suggested change

	the DANDI API. This library helps create and validate DANDI schema-compliant metadata for `Dandisets`
	the DANDI API. This library helps create and validate DANDI schema-compliant metadata for Dandisets

[melster1010]

we formatted "Dandisets" consistently that way throughout the handbook, using the code element, so I was following suit

[waxlamp]

Then I agree that, for consistency, it should be formatted as a code element.

But on a broader level, I don't think that is the right choice. Can you point me to the style policy/discussion where this decision was made?

[melster1010]

there was never any discussion or decision made, it had been consistently styled that way before I came on board so I followed that set standard; in hindsight I agree it's not a great idea to use the code element as way to emphasize a term that isn't code! we have an entry in the stylesheet for spelling the term with an initial cap, we can revisit and decide whether to also universally remove the code formatting

[waxlamp]

Let's make the decision now to remove the code element from the term "Dandiset". Can you update the stylesheet, @melster1010?

[melster1010]

@waxlamp sure - I'll have to update the stylesheet, remove the special formatting from "Dandiset" in the Handbook files, as well as this readme (as separate PR)