Improve inline docs (#2460)

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

packages/hooks/src/use_future.rs

@@ -5,12 +5,16 @@ use dioxus_signals::*;
 use std::future::Future;
 use std::ops::Deref;
 
-/// A hook that allows you to spawn a future.
-/// This future will **not** run on the server
-/// The future is spawned on the next call to `wait_for_next_render` which means that it will not run on the server.
-/// To run a future on the server, you should use `spawn` directly.
-/// `use_future` **won't return a value**.
-/// If you want to return a value from a future, use `use_resource` instead.
+/// A hook that allows you to spawn a future the first time you render a component.
+///
+///
+/// This future will **not** run on the server. To run a future on the server, you should use [`spawn_isomorphic`] directly.
+///
+///
+/// `use_future` **won't return a value**. If you want to return a value from a future, use [`crate::use_resource()`] instead.
+///
+/// ## Example
+///
 /// ```rust
 /// # use dioxus::prelude::*;
 /// # use std::time::Duration;
@@ -35,6 +39,9 @@ use std::ops::Deref;
 ///     }
 /// }
 /// ```
+#[doc = include_str!("../docs/rules_of_hooks.md")]
+#[doc = include_str!("../docs/moving_state_around.md")]
+#[doc(alias = "use_async")]
 pub fn use_future<F>(mut future: impl FnMut() -> F + 'static) -> UseFuture
 where
     F: Future + 'static,