From a034e40f7c0e325938da92894ee34f589f372e0a Mon Sep 17 00:00:00 2001
From: Héctor Ramón Jiménez <hector@hecrj.dev>
Date: Sun, 17 Mar 2024 14:36:42 +0100
Subject: Clarify chain nature of `run` function

---
 src/lib.rs | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src')

diff --git a/src/lib.rs b/src/lib.rs
index 902a5f36..d238e78a 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -343,6 +343,10 @@ pub type Result = std::result::Result<(), Error>;
 /// Runs a basic iced application with default [`Settings`] given its title,
 /// update, and view logic.
 ///
+/// This is equivalent to chaining [`program`] with [`Program::run`].
+///
+/// [`Program::run`]: application::Program::run
+///
 /// # Example
 /// ```no_run
 /// use iced::widget::{button, column, text, Column};
-- 
cgit