From 900bc3b6c6b79f91a01a24fcda841808d13e2048 Mon Sep 17 00:00:00 2001
From: HampusM <hampus@hampusmat.com>
Date: Fri, 2 Aug 2024 16:43:25 +0200
Subject: docs(engine): correct Engine function comments

---
 engine/src/lib.rs | 10 ++--------
 1 file changed, 2 insertions(+), 8 deletions(-)

(limited to 'engine')

diff --git a/engine/src/lib.rs b/engine/src/lib.rs
index 6d7fa1e..3080047 100644
--- a/engine/src/lib.rs
+++ b/engine/src/lib.rs
@@ -56,10 +56,7 @@ pub struct Engine
 
 impl Engine
 {
-    /// Creates and initializes a new engine.
-    ///
-    /// # Errors
-    /// Will return `Err` if window creation or window configuration fails.
+    /// Returns a new `Engine`.
     #[must_use]
     pub fn new() -> Self
     {
@@ -107,10 +104,7 @@ impl Engine
         self.world.add_extension(extension);
     }
 
-    /// Starts the engine.
-    ///
-    /// # Errors
-    /// Will return `Err` if updating the window fails.
+    /// Emits the [`StartEvent`] event and then runs the event loop.
     pub fn start(&self)
     {
         self.world.emit(StartEvent);
-- 
cgit v1.2.3-18-g5258