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

Fix Options JSON schema description #8081

Merged
merged 1 commit into from Oct 20, 2023

Conversation

MichaReiser
Copy link
Member

Summary

It's seems that schemars uses the comment of a flattened struct for the enclosing struct.
In our case, the comment on CommonLintOptions was used for Options.

I moved the lint section comment to LintOptions which avoids this undesired inheritance.

Test Plan

Reviewed the json schema changes

@MichaReiser
Copy link
Member Author

Current dependencies on/for this PR:

This comment was auto-generated by Graphite.

@MichaReiser MichaReiser added the documentation Improvements or additions to documentation label Oct 20, 2023
@MichaReiser MichaReiser enabled auto-merge (squash) October 20, 2023 00:14
@MichaReiser MichaReiser merged commit 1dd264b into main Oct 20, 2023
15 checks passed
@MichaReiser MichaReiser deleted the fix-options-json-schema-documentation branch October 20, 2023 00:25
@github-actions
Copy link

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

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

Successfully merging this pull request may close these issues.

None yet

2 participants