jtdaugherty/brick
1
1
Fork 0
mirror of https://github.com/jtdaugherty/brick.git synced 2024-11-24 08:43:41 +03:00
Code Issues Projects Releases Wiki Activity

Brick.Widgets.Core.relativeTo: haddock edits to reflect recent behavior change

Browse Source
This commit is contained in:
Jonathan Daugherty 2024-11-21 15:33:12 -08:00
parent adc0fe33c5
commit 6819100e20
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/Brick/Widgets/Core.hs
View File

@ -1089,11 +1089,11 @@ translateBy off p =
--
-- This is only useful for positioning something in a higher layer
-- relative to a reported extent in a lower layer. Any other use is
-- likely to result in the specified widget being rendered as-is with
-- no translation. This is because this function relies on information
-- about lower layer renderings in order to work; using it with a
-- resource name that wasn't rendered in a lower layer will result in
-- this being equivalent to @id@.
-- likely to result in the specified widget not being rendered. This
-- is because this function relies on information about lower layer
-- renderings in order to work; using it with a resource name that
-- wasn't rendered in a lower layer will result in this being equivalent
-- to @emptyWidget@.
--
-- For example, if you have two layers @topLayer@ and @bottomLayer@,
-- then a widget drawn in @bottomLayer@ with @reportExtent Foo@ can be