From 0a95af78f46728b86cb78380791f40f008be99eb Mon Sep 17 00:00:00 2001
From: Héctor Ramón Jiménez <hector@hecrj.dev>
Date: Wed, 18 Sep 2024 23:05:50 +0200
Subject: Add quick example to `widget::button` module

---
 widget/src/button.rs | 46 +++++++++++++++++++++++++++++++++-------------
 1 file changed, 33 insertions(+), 13 deletions(-)

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

diff --git a/widget/src/button.rs b/widget/src/button.rs
index eafa71b9..a76035f7 100644
--- a/widget/src/button.rs
+++ b/widget/src/button.rs
@@ -1,4 +1,20 @@
-//! Allow your users to perform actions by pressing a button.
+//! Buttons allow your users to perform actions by pressing them.
+//!
+//! ```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::button;
+//!
+//! #[derive(Clone)]
+//! enum Message {
+//!     ButtonPressed,
+//! }
+//!
+//! fn view(state: &State) -> Element<'_, Message> {
+//!     button("Press me!").on_press(Message::ButtonPressed).into()
+//! }
+//! ```
 use crate::core::border::{self, Border};
 use crate::core::event::{self, Event};
 use crate::core::layout;
@@ -17,33 +33,37 @@ use crate::core::{
 /// A generic widget that produces a message when pressed.
 ///
 /// ```no_run
-/// # type Button<'a, Message> = iced_widget::Button<'a, Message>;
-/// #
+/// # 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::button;
+///
 /// #[derive(Clone)]
 /// enum Message {
 ///     ButtonPressed,
 /// }
 ///
-/// let button = Button::new("Press me!").on_press(Message::ButtonPressed);
+/// fn view(state: &State) -> Element<'_, Message> {
+///     button("Press me!").on_press(Message::ButtonPressed).into()
+/// }
 /// ```
 ///
 /// If a [`Button::on_press`] handler is not set, the resulting [`Button`] will
 /// be disabled:
 ///
-/// ```
-/// # type Button<'a, Message> = iced_widget::Button<'a, Message>;
-/// #
+/// ```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::button;
+///
 /// #[derive(Clone)]
 /// enum Message {
 ///     ButtonPressed,
 /// }
 ///
-/// fn disabled_button<'a>() -> Button<'a, Message> {
-///     Button::new("I'm disabled!")
-/// }
-///
-/// fn enabled_button<'a>() -> Button<'a, Message> {
-///     disabled_button().on_press(Message::ButtonPressed)
+/// fn view(state: &State) -> Element<'_, Message> {
+///     button("I am disabled!").into()
 /// }
 /// ```
 #[allow(missing_debug_implementations)]
-- 
cgit 


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

---
 widget/src/button.rs | 2 ++
 1 file changed, 2 insertions(+)

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

diff --git a/widget/src/button.rs b/widget/src/button.rs
index a76035f7..3323c0d3 100644
--- a/widget/src/button.rs
+++ b/widget/src/button.rs
@@ -1,5 +1,6 @@
 //! Buttons allow your users to perform actions by pressing them.
 //!
+//! # Example
 //! ```no_run
 //! # mod iced { pub mod widget { pub use iced_widget::*; } }
 //! # pub type State = ();
@@ -32,6 +33,7 @@ use crate::core::{
 
 /// A generic widget that produces a message when pressed.
 ///
+/// # Example
 /// ```no_run
 /// # mod iced { pub mod widget { pub use iced_widget::*; } }
 /// # pub type State = ();
-- 
cgit