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

Resolve misuse of $comment #71

Open
korikuzma opened this issue Sep 18, 2024 · 1 comment
Open

Resolve misuse of $comment #71

korikuzma opened this issue Sep 18, 2024 · 1 comment
Assignees

Comments

@korikuzma
Copy link
Contributor

@ahwagner @larrybabb there are two comments in Statement as seen here. Which one should we go with?

From the JSON Schema documentation:

The $comment keyword is strictly intended for adding comments to a schema. Its value must always be a string. Unlike the annotations title, description, and examples, JSON schema implementations aren't allowed to attach any meaning or behavior to it whatsoever, and may even strip them at any time. Therefore, they are useful for leaving notes to future editors of a JSON schema, but should not be used to communicate to users of the schema.

It seems we should be going back and reviewing the use of $comment in this repo. For now, I think we should just leave these as-is, unless it breaks something.

RST rebuild with MSP b13 is a good catch, LGTM

Originally posted by @ahwagner in #70 (review)

@larrybabb
Copy link
Contributor

@mbrush we need to discuss how $comment is intended to be used in json schema files and whether or not we are applying it consistently. I think @ahwagner, you and I need to walk through this so that we can find the appropriate application for the content you are adding in these fields. @ahwagner raised a few concerns in a recent review.

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

4 participants