summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2021-11-29 14:44:19 +0700
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2021-11-29 14:44:19 +0700
commit2f50d114612e0dc5cb23389ade2a21819836d254 (patch)
tree0582082bf397769fc23eeea3a9d53f48e6783597 /src
parent0648d9d234346ad0f76757ea25bf06852f5b2002 (diff)
downloadiced-2f50d114612e0dc5cb23389ade2a21819836d254.tar.gz
iced-2f50d114612e0dc5cb23389ade2a21819836d254.tar.bz2
iced-2f50d114612e0dc5cb23389ade2a21819836d254.zip
Improve documentation of `Application::run`
Diffstat (limited to 'src')
-rw-r--r--src/application.rs5
1 files changed, 3 insertions, 2 deletions
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