From c1af6afcb78a6c1e41a92076a80f9c44767823ef Mon Sep 17 00:00:00 2001 From: AnonymouX47 Date: Wed, 22 Feb 2023 16:53:13 +0100 Subject: [PATCH] docs: Update `UrwidImageJanitor` docstring --- src/term_image/widget/urwid.py | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/src/term_image/widget/urwid.py b/src/term_image/widget/urwid.py index ff44219f..426f119f 100644 --- a/src/term_image/widget/urwid.py +++ b/src/term_image/widget/urwid.py @@ -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 + ` 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"]