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

Add docs to config structs #34

Merged
merged 2 commits into from
Jun 2, 2024
Merged

Conversation

vinnymeller
Copy link
Owner

No description provided.

Adds the `deny_unknown_fields` serde attribute to config structs.

The downside of this is that configs with unknown fields will now fail,
but the language server can provide error messages for fields. That will
be better for breaking changes in the future.
Adds documentation to each field in the twm configuration files.

These docs are passed through to the generated JSON schema and thus will
be made available in editors to users using a compatible language
server.
@vinnymeller vinnymeller merged commit 6aa4b6b into master Jun 2, 2024
1 check passed
@vinnymeller vinnymeller deleted the add-docs-to-config-structs branch June 2, 2024 02:28
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.

1 participant