mrtoth/baseimage-tutorial-framework
1
0
Fork 0
mirror of https://github.com/avatao-content/baseimage-tutorial-framework synced 2025-07-12 04:46:23 +00:00
Code Issues Releases Wiki Activity

Add sphinx API documentation

Browse Source
This commit is contained in:
Kristóf Tóth
2018-06-01 16:20:20 +02:00
parent c0fb28c46c
commit e80cce00f3
16 changed files with 381 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
lib/tfw/components/terminal_commands.py
View File

@ -19,13 +19,13 @@ class TerminalCommands(ABC):
To receive events you need to subscribe TerminalCommand.callback to a HistoryMonitor
instance.
Inherit from this class and define methods which start with "command_". When the user
Inherit from this class and define methods which start with "command\_". When the user
executes the command specified after the underscore, your method will be invoked. All
such commands must expect the parameter *args which will contain the arguments of the
such commands must expect the parameter \*args which will contain the arguments of the
command.
For example to define a method that runs when someone starts vim in the terminal
you have to define a method like: "def command_vim(self, *args)"
you have to define a method like: "def command_vim(self, \*args)"
You can also use this class to create new commands similarly.
"""