search

w3c / vc-test-suite

Verifiable Credentials WG Test Suite
https://w3c.github.io/vc-test-suite/
BSD 3-Clause "New" or "Revised" License
69 stars 39 forks source link

config.json.example comments could use valid JSON #133

Open marnanel opened 9 months ago

marnanel commented 9 months ago

Lines like

   // The following binary will, given an input file, produce a valid
   // Verifiable Credentials Data Model document.
   // use "type" on Windows as a "cat" replacement
   "generator":"/bin/cat",

Do you think it might be a plan to write it like

   "--": "The following binary will, given an input file, produce a valid",
   "--": "Verifiable Credentials Data Model document.",
   "--": "use 'type' on Windows as a "cat" replacement",
   "generator":"/bin/cat",

?

RFC 8259 says "The names within an object SHOULD be unique." We could just suffix numbers to the key names. But I think this is one of the odd situations whose existence is the reason it's SHOULD and not MUST.

TallTed commented 9 months ago

Alternatively --

   "--": "The following binary will, given an input file, produce a valid Verifiable Credentials Data Model document. Use 'type' on Windows as a "cat" replacement.",
   "generator":"/bin/cat",