mirror of
https://github.com/jtdaugherty/brick.git
synced 2024-12-02 11:05:10 +03:00
Dialog: clarify purpose in documentation (w.r.t. #149)
This commit is contained in:
parent
c460bbb9c5
commit
2c85349343
@ -2,6 +2,14 @@
|
||||
{-# LANGUAGE OverloadedStrings #-}
|
||||
-- | This module provides a simple dialog widget. You get to pick the
|
||||
-- dialog title, if any, as well as its body and buttons.
|
||||
--
|
||||
-- Note that this dialog is really for simple use cases where you want
|
||||
-- to get the user's answer to a question, such as "Would you like
|
||||
-- to save changes before quitting?" If you require something more
|
||||
-- sophisticated, you'll need to build it yourself. You might also
|
||||
-- consider seeing the 'Brick.Forms' module for help with input
|
||||
-- management, and see the implementation of this module to see how to
|
||||
-- reproduce a dialog-style UI.
|
||||
module Brick.Widgets.Dialog
|
||||
( Dialog
|
||||
, dialogTitle
|
||||
|
Loading…
Reference in New Issue
Block a user