mirror of
				https://github.com/avatao-content/baseimage-tutorial-framework
				synced 2025-11-04 12:02:55 +00:00 
			
		
		
		
	Add a huge bunch of docstrings
This commit is contained in:
		@@ -15,7 +15,15 @@ LOG = logging.getLogger(__name__)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
class TFWServer:
 | 
			
		||||
    """
 | 
			
		||||
    This class handles the proxying of messages between the frontend and event handers.
 | 
			
		||||
    It proxies messages from the "/ws" route to all event handlers subscribed to a ZMQ
 | 
			
		||||
    SUB socket. It also manages an FSM you can define as a constructor argument.
 | 
			
		||||
    """
 | 
			
		||||
    def __init__(self, fsm_type):
 | 
			
		||||
        """
 | 
			
		||||
        :param fsm_type: the type of FSM you want TFW to use
 | 
			
		||||
        """
 | 
			
		||||
        self._fsm = fsm_type()
 | 
			
		||||
        self._fsm_updater = FSMUpdater(self._fsm)
 | 
			
		||||
        self._fsm_manager = FSMManager(self._fsm)
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user