jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 04:52:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adding more documentation around switch method returns

Browse Source
This commit is contained in:
Artem Veremey
2021-03-17 08:35:52 -07:00
parent 1679689b29
commit 14fd48a5d4
1 changed files with 11 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
gamestonk_terminal/papermill/papermill_controller.py
View File

@@ -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]):