Skip to content

Commit

Permalink
fix documentation comment for multiple overlays
Browse files Browse the repository at this point in the history
  • Loading branch information
lucatrv committed Sep 6, 2023
1 parent 2f02c01 commit 09bab3a
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions src/native/modal.rs
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,13 @@ where
Renderer: core::Renderer,
Renderer::Theme: StyleSheet,
{
/// Creates a new [`Modal`] wrapping the underlying element to
/// show some content as an overlay.
/// Creates a new [`Modal`] wrapping the underlying element to show some content as an overlay.
///
/// `state` is the content's state, assigned at the creation of the
/// overlying content.
/// If [`overlay`] is `Some`, the contained [`Element`] is shown over the underlying element.
/// If [`overlay`] is `None`, only the underlying element is shown.
///
/// It expects:
/// * the underlay [`Element`] on which this [`Modal`]
/// will be wrapped around.
/// * the underlay [`Element`] on which this [`Modal`] will be wrapped around.
/// * the optional overlay [`Element`] of the [`Modal`].
pub fn new(
underlay: impl Into<Element<'a, Message, Renderer>>,
Expand Down

0 comments on commit 09bab3a

Please sign in to comment.