@@ -133,7 +133,11 @@ class DialogAskConnect(_DialogBase):
133133 message_type = DialogType .ASKCONNECT
134134
135135 def __init__ (self , title , time = 10 ):
136- """Set all the base attributes on instantiation."""
136+ """Set all the base attributes on instantiation.
137+
138+ :param str title: The IP address to connect to.
139+ :param int time: The time (in seconds) for the notification to display.
140+ """
137141 self .title = title
138142 self .time = time
139143
@@ -152,7 +156,15 @@ class DialogEntry(_DialogBase):
152156 message_type = DialogType .ENTRY
153157
154158 def __init__ (self , title , msg , command , color = WHITE , time = 10 ):
155- """Set all the base attributes on instantiation."""
159+ """Set all the base attributes on instantiation.
160+
161+ :param str title: The title of the entry box and top text.
162+ :param str msg: The message of the entry box.
163+ :param str command: The command to execute on entry. Note that
164+ the entered values are arguments of the command on entry.
165+ :param Color color: The color of the toptext notification.
166+ :param int time: The time (in seconds) for the notification to display.
167+ """
156168 self .title = title
157169 self .msg = msg
158170 self ._command = command
@@ -186,7 +198,20 @@ class DialogMenu(_DialogBase):
186198
187199 def __init__ (
188200 self , title , msg , command , color = WHITE , time = 10 , options = None ):
189- """Set all the base attributes on instantiation."""
201+ """Set all the base attributes on instantiation.
202+
203+ :param str title: The title of the menu box and top text.
204+ :param str msg: The message of the menu box.
205+ :param str command: The command to execute on entry. Note that
206+ the key/item of the selected option will be the argument.
207+ :param Color color: The color of the toptext notification.
208+ :param int time: The time (in seconds) for the notification to display.
209+ :param iterable options: The options for the menu. If a dictionary
210+ is passed, the values will be displayed while the keys will be
211+ the argument of the command when selected.
212+ If any other iterable is used, the items will be both the
213+ displayed text and the argument.
214+ """
190215 self .title = title
191216 self .msg = msg
192217 self ._command = command
@@ -237,7 +262,12 @@ class DialogMsg(_DialogBase):
237262 message_type = DialogType .MSG
238263
239264 def __init__ (self , title , color = WHITE , time = 10 ):
240- """Set all the base attributes on instantiation."""
265+ """Set all the base attributes on instantiation.
266+
267+ :param str title: The top text.
268+ :param Color color: The color of the toptext notification.
269+ :param int time: The time (in seconds) for the notification to display.
270+ """
241271 self .title = title
242272 self .color = color
243273 self .time = time
@@ -257,7 +287,13 @@ class DialogText(_DialogBase):
257287 message_type = DialogType .TEXT
258288
259289 def __init__ (self , title , msg , color = WHITE , time = 10 ):
260- """Set all the base attributes on instantiation."""
290+ """Set all the base attributes on instantiation.
291+
292+ :param str title: The title of the message box and top text.
293+ :param str msg: The message of the message box.
294+ :param Color color: The color of the toptext notification.
295+ :param int time: The time (in seconds) for the notification to display.
296+ """
261297 self .title = title
262298 self .msg = msg
263299 self .color = color
0 commit comments