Skip to content

Commit 0d91852

Browse files
committed
Fix documentation of _process_screen method
The documentation was a way outdated. It does something completely different now. Make return statements consistent.
1 parent 3e8a407 commit 0d91852

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

simpleline/render/screen_scheduler.py

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -213,9 +213,13 @@ def _process_screen_callback(self, signal, data):
213213
self._process_screen()
214214

215215
def _process_screen(self):
216-
"""Draws the current screen and returns True if user input is requested.
216+
"""Process the current screen.
217217
218-
If modal screen is requested, starts a new loop and initiates redraw after it ends.
218+
1) It will call setup if the screen is not already set.
219+
2a) If setup was success then draw the screen.
220+
2b) If setup wasn't successful then pop the screen and try to process next in the stack.
221+
Continue by (1).
222+
3)Ask for user input if requested.
219223
"""
220224
top_screen = self._get_last_screen()
221225

@@ -249,7 +253,7 @@ def _process_screen(self):
249253
raise
250254
except Exception: # pylint: disable=broad-except
251255
self._event_loop.enqueue_signal(ExceptionSignal(self))
252-
return False
256+
return
253257

254258
def _draw_screen(self, active_screen):
255259
"""Draws the current `active_screen`.

0 commit comments

Comments
 (0)