From e98a441b0fa0c1e2ddffe615a48f3fe23a4fedad Mon Sep 17 00:00:00 2001
From: Héctor Ramón Jiménez <hector@hecrj.dev>
Date: Thu, 19 Sep 2024 03:40:38 +0200
Subject: Show `image` doc example in multiple places

---
 widget/src/helpers.rs | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'widget/src/helpers.rs')

diff --git a/widget/src/helpers.rs b/widget/src/helpers.rs
index 0699446d..bae2e10e 100644
--- a/widget/src/helpers.rs
+++ b/widget/src/helpers.rs
@@ -1047,7 +1047,26 @@ where
 
 /// Creates a new [`Image`].
 ///
+/// Images display raster graphics in different formats (PNG, JPG, etc.).
+///
 /// [`Image`]: crate::Image
+///
+/// # Example
+/// ```no_run
+/// # mod iced { pub mod widget { pub use iced_widget::*; } }
+/// # pub type State = ();
+/// # pub type Element<'a, Message> = iced_widget::core::Element<'a, Message, iced_widget::Theme, iced_widget::Renderer>;
+/// use iced::widget::image;
+///
+/// enum Message {
+///     // ...
+/// }
+///
+/// fn view(state: &State) -> Element<'_, Message> {
+///     image("ferris.png").into()
+/// }
+/// ```
+/// <img src="https://github.com/iced-rs/iced/blob/9712b319bb7a32848001b96bd84977430f14b623/examples/resources/ferris.png?raw=true" width="300">
 #[cfg(feature = "image")]
 pub fn image<Handle>(handle: impl Into<Handle>) -> crate::Image<Handle> {
     crate::Image::new(handle.into())
-- 
cgit