mirror of
https://github.com/jtdaugherty/brick.git
synced 2024-09-11 23:57:22 +03:00
applyEdit: better docs
This commit is contained in:
parent
f2e5130114
commit
0965a0d372
@ -181,10 +181,12 @@ editor :: Z.GenericTextZipper a
|
||||
-> Editor a n
|
||||
editor name limit s = Editor (Z.textZipper (Z.lines s) limit) name
|
||||
|
||||
-- | Apply an editing operation to the editor's contents. Bear in mind
|
||||
-- that you should only apply zipper operations that operate on the
|
||||
-- current line; the editor will only ever render the first line of
|
||||
-- text.
|
||||
-- | Apply an editing operation to the editor's contents.
|
||||
--
|
||||
-- This is subject to the restrictions of the underlying text zipper;
|
||||
-- for example, if the underlying zipper has a line limit configured,
|
||||
-- any edits applied here will be be ignored if they edit text outside
|
||||
-- the line limit.
|
||||
applyEdit :: (Z.TextZipper t -> Z.TextZipper t)
|
||||
-- ^ The 'Data.Text.Zipper' editing transformation to apply
|
||||
-> Editor t n
|
||||
|
Loading…
Reference in New Issue
Block a user