Documentation.

Author: ioquatix

lib/async/container/supervisor/client.rb

@@ -9,6 +9,7 @@
 module Async
 	module Container
 		module Supervisor
+			# A client provides a mechanism to connect to a supervisor server in order to execute operations.
 			class Client
 				def initialize(endpoint: Supervisor.endpoint)
 					@endpoint = endpoint

lib/async/container/supervisor/server.rb

@@ -12,6 +12,9 @@
 module Async
 	module Container
 		module Supervisor
+			# The server represents the main supervisor process which is responsible for managing the lifecycle of other processes.
+			#
+			# There are various tasks that can be executed by the server, such as restarting the process group, and querying the status of the processes. The server is also responsible for managing the lifecycle of the monitors, which can be used to monitor the status of the connected workers.
 			class Server
 				def initialize(monitors: [], endpoint: Supervisor.endpoint)
 					@monitors = monitors

lib/async/container/supervisor/worker.rb

@@ -9,6 +9,9 @@
 module Async
 	module Container
 		module Supervisor
+			# A worker represents a long running process that can be controlled by the supervisor.
+			#
+			# There are various tasks that can be executed by the worker, such as dumping memory, threads, and garbage collection profiles.
 			class Worker < Client
 				def self.run(...)
 					self.new(...).run