Skip to content

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
@MichaReiser MichaReiser deleted the fix-options-json-schema-documentation branch October 20, 2023 00:25
@github-actions
Copy link
Contributor

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.

3 participants