summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-04-01 00:25:33 +0200
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-04-02 03:44:14 +0200
commit26a35b7d7e72ab8f685e75b0332bade1efef92d8 (patch)
tree103aaad9e4eef039bde708e1bf1ee93af3d64dd7
parentc73f23c38057a4b1af368da5ac3268de317a55fa (diff)
downloadiced-26a35b7d7e72ab8f685e75b0332bade1efef92d8.tar.gz
iced-26a35b7d7e72ab8f685e75b0332bade1efef92d8.tar.bz2
iced-26a35b7d7e72ab8f685e75b0332bade1efef92d8.zip
Clarify return policy of `Application::run`
-rw-r--r--src/application.rs8
-rw-r--r--src/sandbox.rs4
-rw-r--r--winit/src/application.rs4
3 files changed, 8 insertions, 8 deletions
diff --git a/src/application.rs b/src/application.rs
index 551a9a79..43aa57a3 100644
--- a/src/application.rs
+++ b/src/application.rs
@@ -84,10 +84,10 @@ use crate::{window, Command, Element, Executor, Settings, Subscription};
pub trait Application: Sized {
/// The [`Executor`] that will run commands and subscriptions.
///
- /// The [`executor::Default`] can be a good starting point!
+ /// The [default executor] can be a good starting point!
///
/// [`Executor`]: trait.Executor.html
- /// [`executor::Default`]: executor/struct.Default.html
+ /// [default executor]: executor/struct.Default.html
type Executor: Executor;
/// The type of __messages__ your [`Application`] will produce.
@@ -172,8 +172,8 @@ pub trait Application: Sized {
/// Runs the [`Application`].
///
- /// This method will take control of the current thread and __will NOT
- /// return__.
+ /// On native platforms, this method will take control of the current thread
+ /// and __will NOT return__.
///
/// It should probably be that last thing you call in your `main` function.
///
diff --git a/src/sandbox.rs b/src/sandbox.rs
index 4ea8de98..598a7625 100644
--- a/src/sandbox.rs
+++ b/src/sandbox.rs
@@ -115,8 +115,8 @@ pub trait Sandbox {
/// Runs the [`Sandbox`].
///
- /// This method will take control of the current thread and __will NOT
- /// return__.
+ /// On native platforms, this method will take control of the current thread
+ /// and __will NOT return__.
///
/// It should probably be that last thing you call in your `main` function.
///
diff --git a/winit/src/application.rs b/winit/src/application.rs
index d5f957bf..37682901 100644
--- a/winit/src/application.rs
+++ b/winit/src/application.rs
@@ -100,8 +100,8 @@ pub trait Application: Sized {
/// Runs the [`Application`] with the provided [`Settings`].
///
- /// This method will take control of the current thread and __will NOT
- /// return__.
+ /// On native platforms, this method will take control of the current thread
+ /// and __will NOT return__.
///
/// It should probably be that last thing you call in your `main` function.
///