Fixed failing doc tests

thatmagicalcat · Oct 30, 2023 · 36fe960 · 36fe960
1 parent 631b5f2
commit 36fe960
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 11 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -14,13 +14,13 @@
 //! # Examples
 //! 
 //! A basic web server that serves "Hello, World!"
-//! ```rust
-//! use crane_webserver::webserver::WebServer;
+//! ```no_run
+//! use crane_webserver::*;
 //!
 //! fn main() {
 //!     let server = WebServer::bind("127.0.0.1:8888", |path, _query| {
 //!         match path.as_str() {
-//!             "/" => root()
+//!             "/" => root(),
 //!             _ => ResponseBuilder::new().build()
 //!         }
 //!     }).unwrap();

diff --git a/src/response.rs b/src/response.rs
@@ -8,8 +8,9 @@ use crate::HttpStatus;
 ///
 /// # Examples
 ///
-/// ```rust
-/// use crane_webserver::webserver::WebServer;
+/// ```no_run
+/// use crane_webserver::*;
+///
 /// fn main() {
 ///     // .. server setup
 /// }

diff --git a/src/webserver.rs b/src/webserver.rs
@@ -20,12 +20,13 @@ type Handler = dyn Fn(String, Query) -> Response + 'static + Send + Sync;
 /// # Examples
 ///
 /// A basic web server that serves "Hello, World!"
-/// ```rust
-/// use crane_webserver::webserver::WebServer;
+/// ```no_run
+/// use crane_webserver::*;
+///
 /// fn main() {
 ///     let server = WebServer::bind("127.0.0.1:8888", |path, _query| {
 ///         match path.as_str() {
-///             "/" => root()
+///             "/" => root(),
 ///             _ => ResponseBuilder::new().build()
 ///         }
 ///     }).unwrap();
@@ -57,18 +58,23 @@ impl WebServer {
     ///
     /// # Examples
     ///
-    /// ```rust
-    /// use crane_webserver::webserver::WebServer;
+    /// ```no_run
+    /// use crane_webserver::*;
+    ///
     /// fn main() {
     ///     let server = WebServer::bind("127.0.0.1:8888", |path, _query| {
     ///         match path.as_str() {
-    ///             "/" => root()
+    ///             "/" => root(),
     ///             _ => ResponseBuilder::new().build()
     ///         }
     ///     }).unwrap(); 
     ///
     ///     server.start();
     /// }
+    ///
+    /// fn root() -> Response {
+    ///     ResponseBuilder::new().build()
+    /// }
     /// ```
     pub fn bind<T: ToSocketAddrs, F: Fn(String, Query) -> Response + Send + Sync + 'static>(
         addr: T,