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

remove comments for online validators #38

Closed
wants to merge 1 commit into from
Closed

Conversation

rbavery
Copy link
Collaborator

@rbavery rbavery commented Sep 20, 2024

Description

This removes comments so that the schema passes stricter jsonschema requirements that are common in online jsonschema validators. I think this is a non breaking change since it doesn't affect python validation. I would prefer to keep comments in but would rather be able to see errors neatly presented in online validators.

I did the quick thing in just removing all comments but probably some of these comments can be kept if they don't break jsonschema validation.

Related Issue

#37

Type of Change

  • 📚 Examples, docs, tutorials or dependencies update;
  • 🔧 Bug fix (non-breaking change which fixes an issue);
  • 🥂 Improvement (non-breaking change which improves an existing feature);
  • 🚀 New feature (non-breaking change which adds functionality);
  • 💥 Breaking change (fix or feature that would cause existing functionality to change);
  • 🔐 Security fix.

Checklist

  • I've read the CONTRIBUTING.md guide;
  • I've updated the code style using make check;

Copy link
Collaborator

@fmigneault fmigneault left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I insist on keeping the $comment entries that are permitted, as described in #37 (comment). Otherwise, the multi-level properties becomes extremely confusing. The "ok" locations could be reworded to include the "not ok" under it.

I had actually done so already some time ago, just completely forgot to integrate the PR:
main...crim-ca:mlm-extension:fix-comments

@rbavery
Copy link
Collaborator Author

rbavery commented Sep 20, 2024

Thanks for finding and reopening that, I'll close this in favor of #39

@rbavery rbavery closed this Sep 20, 2024
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

Successfully merging this pull request may close these issues.

2 participants