Add some missing docstrings

diff --git a/qweechat/config.py b/qweechat/config.py
index ae7585d0648d0bdfcbf374872c4dee738be81c65..2aa5909615f480483f0f8bec84ba1248ffc0f2ad 100644 (file)
--- a/qweechat/config.py
+++ b/qweechat/config.py
@@ -128,5 +128,6 @@ def write(config):
 
 
 def color_options():
+    """Return color options."""
     global config_color_options
     return config_color_options

diff --git a/qweechat/network.py b/qweechat/network.py
index 78bb0ce6e2970d170ac4a9b33ea643c03e0a153b..064c45e36494d374919be694cc878ef12746f37c 100644 (file)
--- a/qweechat/network.py
+++ b/qweechat/network.py
@@ -111,12 +111,15 @@ class Network(QtCore.QObject):
         self.statusChanged.emit(self.status_disconnected, None)
 
     def is_connected(self):
+        """Return True if the socket is connected, False otherwise."""
         return self._socket.state() == QtNetwork.QAbstractSocket.ConnectedState
 
     def is_ssl(self):
+        """Return True if SSL is used, False otherwise."""
         return self._ssl
 
     def connect_weechat(self, server, port, ssl, password, lines):
+        """Connect to WeeChat."""
         self._server = server
         try:
             self._port = int(port)
@@ -139,6 +142,7 @@ class Network(QtCore.QObject):
         self.statusChanged.emit(self.status_connecting, None)
 
     def disconnect_weechat(self):
+        """Disconnect from WeeChat."""
         if self._socket.state() == QtNetwork.QAbstractSocket.UnconnectedState:
             return
         if self._socket.state() == QtNetwork.QAbstractSocket.ConnectedState:
@@ -149,12 +153,15 @@ class Network(QtCore.QObject):
         self._socket.abort()
 
     def send_to_weechat(self, message):
+        """Send a message to WeeChat."""
         self._socket.write(message.encode('utf-8'))
 
     def desync_weechat(self):
+        """Desynchronize from WeeChat."""
         self.send_to_weechat('desync\n')
 
     def sync_weechat(self):
+        """Synchronize with WeeChat."""
         self.send_to_weechat('\n'.join(_PROTO_SYNC_CMDS))
 
     def status_icon(self, status):