From 31d86c5a930be08a36273e6d036a9b2adf24c658 Mon Sep 17 00:00:00 2001 From: Leynos Date: Sun, 15 Jun 2025 10:55:07 +0100 Subject: [PATCH 1/2] Consolidate workers method docs --- src/server.rs | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/src/server.rs b/src/server.rs index a0d8ae4a..e445e23d 100644 --- a/src/server.rs +++ b/src/server.rs @@ -86,7 +86,7 @@ where /// /// # Examples /// - /// ``` + /// ```ignore /// let server = WireframeServer::new(factory).with_preamble::(); /// ``` #[must_use] @@ -114,7 +114,8 @@ where { /// Set the number of worker tasks to spawn for the server. /// - /// Ensures at least one worker is configured. + /// The count is clamped to at least one so a worker is always + /// present. Returns a new server instance with the updated value. /// /// # Examples /// @@ -123,23 +124,11 @@ where /// /// let factory = || WireframeApp::new().unwrap(); /// let server = WireframeServer::new(factory).workers(4); - /// ``` - #[must_use] - /// Sets the number of worker tasks to spawn, ensuring at least one worker is configured. - /// - /// Returns a new `WireframeServer` instance with the updated worker count. If `count` is less than 1, it defaults to 1. - /// - /// # Examples - /// - /// ```ignore - /// use wireframe::{app::WireframeApp, server::WireframeServer}; - /// - /// let factory = || WireframeApp::new().unwrap(); - /// let server = WireframeServer::new(factory).workers(4); /// assert_eq!(server.worker_count(), 4); /// let server = server.workers(0); /// assert_eq!(server.worker_count(), 1); /// ``` + #[must_use] pub fn workers(mut self, count: usize) -> Self { self.workers = count.max(1); self From 324eca09efdd79aeb53702e6f8ca19a9de83cf45 Mon Sep 17 00:00:00 2001 From: Leynos Date: Sun, 15 Jun 2025 11:52:30 +0100 Subject: [PATCH 2/2] Fix doctest examples --- src/server.rs | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/src/server.rs b/src/server.rs index e445e23d..ec04cc9d 100644 --- a/src/server.rs +++ b/src/server.rs @@ -86,8 +86,12 @@ where /// /// # Examples /// - /// ```ignore - /// let server = WireframeServer::new(factory).with_preamble::(); + /// ```no_run + /// use wireframe::{app::WireframeApp, server::WireframeServer}; + /// #[derive(bincode::Decode)] + /// struct MyPreamble; + /// let server = WireframeServer::new(|| WireframeApp::default()) + /// .with_preamble::(); /// ``` #[must_use] pub fn with_preamble(self) -> WireframeServer @@ -162,7 +166,7 @@ where /// /// # Examples /// - /// ```ignore + /// ```no_run /// use wireframe::{app::WireframeApp, server::WireframeServer}; /// /// let factory = || WireframeApp::new().unwrap();