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

Document the format of veda-tags.json #295

Open
olejandro opened this issue Jan 21, 2025 · 2 comments
Open

Document the format of veda-tags.json #295

olejandro opened this issue Jan 21, 2025 · 2 comments
Assignees

Comments

@olejandro
Copy link
Member

olejandro commented Jan 21, 2025

I'm wondering if we should document somewhere the format of veda-tags.json, the allowed fields and their default values? The tricky thing is how to do it in a way that we remember to keep up to date when we modify the code... I would have suggested a comment at the top of the file itself, but JSON doesn't allow comments 😅 (another little reason to use YAML!), perhaps in the function in datatypes.py that reads the file in?

Originally posted by @siddharth-krishna in #292 (review)

@olejandro
Copy link
Member Author

How about defining a schema for it and then testing agains it in our unit tests?
I found an example here.

@siddharth-krishna
Copy link
Collaborator

Great idea! I think editors like VS Code can also pick up schemas and show errors when you're editing the file. :)

@siddharth-krishna siddharth-krishna self-assigned this Jan 22, 2025
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