From 2f50d114612e0dc5cb23389ade2a21819836d254 Mon Sep 17 00:00:00 2001
From: Héctor Ramón Jiménez <hector0193@gmail.com>
Date: Mon, 29 Nov 2021 14:44:19 +0700
Subject: Improve documentation of `Application::run`

---
 src/application.rs | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'src')

diff --git a/src/application.rs b/src/application.rs
index 5728dc0b..b722c8a3 100644
--- a/src/application.rs
+++ b/src/application.rs
@@ -188,9 +188,10 @@ pub trait Application: Sized {
     /// Runs the [`Application`].
     ///
     /// On native platforms, this method will take control of the current thread
-    /// until the event loop of the main window exits.
+    /// until the [`Application`] exits.
     ///
-    /// Does never return on the web platform
+    /// On the web platform, this method __will NOT return__ unless there is an
+    /// [`Error`] during startup.
     ///
     /// [`Error`]: crate::Error
     fn run(settings: Settings<Self::Flags>) -> crate::Result
-- 
cgit