Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
marnanel opened this issue Sep 22, 2023 · 1 comment
Open

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

marnanel opened this issue Sep 22, 2023 · 1 comment

Comments

@marnanel
Copy link

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
Copy link
Member

TallTed commented Sep 28, 2023

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",

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants