-
-
Notifications
You must be signed in to change notification settings - Fork 925
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
Improve inline docs #2460
Merged
Merged
Improve inline docs #2460
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
added
documentation
Improvements or additions to documentation
hooks
Changes to built-in hook package
signals
Related to the signals crate
html
Related to the html crate
labels
May 29, 2024
jkelleyrtp
approved these changes
Jun 7, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wow. So much work went into this.
At some point we should propagate more of this onto the guide itself too.
DogeDark
pushed a commit
to DogeDark/dioxus
that referenced
this pull request
Jul 3, 2024
Improve inline docs * improve incorrect event handler return error message * Improve event handler docs * document the eval functions * document spawn and common spawn errors * fix event handler docs * add notes about how you use attributes and elements in rsx * add doc aliases for attributes and events we rename * add some more aliases for common search terms * don't doc ignore any public examples in core * don't ignore public doc examples in ssr * don't ignore examples in the dioxus package readme * add a warning when you launch without a renderer enabled * fix some outdated element docs * add a bunch of examples to resource * add notes about desktop events * add more docs for use_resource * add on_unimplemented hint to Dependency * fix some unresolved links * add examples to each of the router traits * add not implemented errors for router traits * add an example to the routable trait * expand rsx macro docs * improve memo docs * update the dioxus readme * mention dioxus crate features in the docs * fix a bunch of doc tests * fix html doc tests * fix router doc tests * fix dioxus signals doc tests * fix dioxus ssr doc tests * fix use_future example in the hooks cheat sheet * add a javascript alias for eval * fix hook explanation values * remove unused embed-doc-image dependency
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
backport
PRs that should be back ported to the last release
documentation
Improvements or additions to documentation
hooks
Changes to built-in hook package
html
Related to the html crate
signals
Related to the signals crate
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.
The dioxus docsite is pretty good at getting you started with dioxus, but our inline and
docs.rs
docs are currently pretty sparse in comparison. This PR improves the inline docs for thecore
,html
,hooks
, andsignals
cratesGoals:
doc(alias)
function requires argument type to outlive 'static
use of moved value: your_value value used here after move
async block may outlive the current function, but it borrows value, which is owned by the current function
use of moved value: value. move occurs because value has type YourType, which does not implement the Copy trait
Fixes #2390