Skip to content

Commit

Permalink
docs: Update UrwidImageJanitor docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
AnonymouX47 committed Feb 22, 2023
1 parent 99b0a19 commit c1af6af
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions src/term_image/widget/urwid.py
Original file line number Diff line number Diff line change
Expand Up @@ -507,16 +507,19 @@ def _ti_calc_trim(


class UrwidImageJanitor(urwid.WidgetWrap):
"""A widget wrapper that monitors images of some graphics-based render styles and
clears them off the screen when necessary.
"""A widget wrapper that monitors images of some :ref:`graphics-based
<graphics-based>` render styles and clears them off the screen when necessary.
Args:
widget: A widget containing image widgets (possibly recursively).
For this widget to function properly, ensure that its position **relative to the
screen** can never change. It's most advisable to use this widget to wrap the base
widget but it may be used to wrap any other widget and will function properly as
long as the condition mentioned earlier is met.
NOTE:
For this widget to function properly, ensure that the position of its top-left
corner, **relative to the screen** can **never** change.
It's most advisable to use this widget to wrap the topmost widget but it may
be used to wrap any other widget and will function properly as long as the
condition mentioned earlier is met.
"""

no_cache = ["render"]
Expand Down

0 comments on commit c1af6af

Please sign in to comment.