From 14fd48a5d4fa971aedffa0ff8d9e77cc473298d3 Mon Sep 17 00:00:00 2001 From: Artem Veremey Date: Wed, 17 Mar 2021 08:35:52 -0700 Subject: [PATCH] Adding more documentation around switch method returns --- .../papermill/papermill_controller.py | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/gamestonk_terminal/papermill/papermill_controller.py b/gamestonk_terminal/papermill/papermill_controller.py index a2d5556e2d8..e7bd3366869 100644 --- a/gamestonk_terminal/papermill/papermill_controller.py +++ b/gamestonk_terminal/papermill/papermill_controller.py @@ -24,7 +24,15 @@ class PapermillController: ) def switch(self, an_input: str): - """Process and dispatch input""" + """Process and dispatch input + + Returns + ------- + True, False or None + False - quit the menu + True - quit the program + None - continue in the menu + """ (known_args, other_args) = self.papermill_parser.parse_known_args( an_input.split() ) @@ -38,11 +46,11 @@ class PapermillController: print_papermill() def call_q(self, _): - """Process Q command""" + """Process Q command - quit the menu""" return False def call_quit(self, _): - """Process Quit command""" + """Process Quit command - quit the program""" return True def call_dd(self, other_args: List[str]):