add documentation for function component type alias#2435
Closed
sbruton wants to merge 2 commits into
Closed
Conversation
|
Visit the preview URL for this PR (updated for commit 688a9b8): https://yew-rs-api--pr2435-master-evghheeu.web.app (expires Sat, 12 Feb 2022 09:33:43 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
Member
|
The attributes of the function component are applied to the hidden inner function at the moment. I think it might make more sense to extract the doc comments from the original attributes and apply them on the type alias? |
Contributor
Author
|
Sounds right. I don't have time to do this right now. I'll circle back around when I can and see if it's still outstanding. |
ranile
added
the
S-waiting-on-author
3 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Description
The
#[function_component]proc macro currently generates the type alias without any documentation. This causes issues when using themissing_docslint, especially when using#![deny(missing_docs)].This PR adds a simple one-line doc tag to the function component's type alias, ending clippy's ceaseless harassment.
Checklist
cargo make pr-flow