Add doc comment on generated inline properties struct #1775
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ealmloff
reviewed
Jan 2, 2024
packages/core-macro/src/component_body_deserializers/inline_props.rs
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a doc comment to the derived properties struct generated from the inline arguments of the component.
This prevents the
missing_docslint to trigger if that is setup for a project (for instance, a CI might prevent progress by denying all lint warnings). This could probably be extended to provide custom doc comments to the struct, or use the doc comment of the component function, but I didn't see the need for that, as this PR will include a link to the original component function in the docs for further info.