Skip to content

Commit

Permalink
Merge pull request #171 from lucatrv/update-modal-code-comments
Browse files Browse the repository at this point in the history
update modal code comments
  • Loading branch information
Andrew Wheeler(Genusis) authored Aug 17, 2023
2 parents 280231a + d107d7d commit 1c3b933
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions src/native/modal.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,8 @@ pub use crate::style::modal::StyleSheet;
/// }
///
/// let modal = Modal::new(
/// false,
/// Text::new("Underlay"),
/// Text::new("Overlay"),
/// Some(Text::new("Overlay")),
/// )
/// .backdrop(Message::CloseModal);
/// ```
Expand All @@ -45,7 +44,7 @@ where
{
/// The underlying element.
underlay: Element<'a, Message, Renderer>,
/// The content of the [`ModalOverlay`](ModalOverlay).
/// The optional content of the [`ModalOverlay`](ModalOverlay).
overlay: Option<Element<'a, Message, Renderer>>,
/// The optional message that will be send when the user clicked on the backdrop.
backdrop: Option<Message>,
Expand All @@ -70,10 +69,9 @@ where
/// overlying content.
///
/// It expects:
/// * if the overlay of the date picker is visible.
/// * the underlay [`Element`] on which this [`Modal`](Modal)
/// will be wrapped around.
/// * the content [`Element`] of the [`Modal`](Modal).
/// * the optional overlay [`Element`] of the [`Modal`](Modal).
pub fn new(
underlay: impl Into<Element<'a, Message, Renderer>>,
overlay: Option<impl Into<Element<'a, Message, Renderer>>>,
Expand Down

0 comments on commit 1c3b933

Please sign in to comment.