From 4e1c746f25ab0d7204dcb0315dd3ce88edabe9f5 Mon Sep 17 00:00:00 2001
From: Adrian Wannenmacher <tfld@tfld.dev>
Date: Tue, 13 Dec 2022 11:22:44 +0100
Subject: [PATCH] document the prelude

---
 packages/router/src/lib.rs | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/packages/router/src/lib.rs b/packages/router/src/lib.rs
index b69fb77c0..50f51705f 100644
--- a/packages/router/src/lib.rs
+++ b/packages/router/src/lib.rs
@@ -36,14 +36,19 @@ pub mod hooks {
     pub use use_route::*;
 }
 
+/// A collection of useful items most applications might need.
+#[forbid(missing_docs)]
 pub mod prelude {
     pub use dioxus_router_core::prelude::*;
 
     pub use crate::components::*;
     pub use crate::hooks::*;
 
-    use dioxus::core::Component;
-    pub fn comp(component: Component) -> ContentAtom<Component> {
+    /// Wrap a [`Component`](dioxus::core::Component) inside a [`ContentAtom`].
+    ///
+    /// This is purely a convenience function.
+    #[must_use]
+    pub fn comp(component: dioxus::core::Component) -> ContentAtom<dioxus::core::Component> {
         ContentAtom(component)
     }
 }