Skip to content

doc: clarify that Vty from customMainWithDefaultVty needs shutdown #530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jtdaugherty merged 1 commit into from
Jun 22, 2025
+4 −0
Merged

doc: clarify that Vty from customMainWithDefaultVty needs shutdown #530

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/Brick/Main.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,10 @@ customMain initialVty buildVty mUserChan app initialAppState = do

-- | Like 'customMainWithVty', except that Vty is initialized with the
-- default configuration.
--
-- The Vty is live when returned to the caller. Use 'shutdown' to
-- finalise it.
--
customMainWithDefaultVty :: (Ord n)
=> Maybe (BChan e)
-- ^ An event channel for sending custom
Expand Down
Loading