Added documentation for socket class and its constructor. (#32)

nanomsg · Sep 13, 2016 · 9542b55 · 9542b55
1 parent 53424ab
commit 9542b55
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/nnpy/socket.py b/nnpy/socket.py
@@ -6,8 +6,21 @@
 ustr = str if sys.version_info[0] > 2 else unicode
 
 class Socket(object):
-
+    """
+    Nanomsg scalability protocols (SP) socket.
+
+    .. seealso:: `nanomsg <http://nanomsg.org/v1.0.0/nanomsg.7.html>`_
+    """
     def __init__(self, domain, protocol):
+        """
+        Create SP socket.
+
+        :param domain: Socket domain `AF_SP` or `AF_SP_RAW`.
+        :param protocol: Type of the socket determining its exact
+            semantics.
+
+        .. seealso:: `nn_socket <http://nanomsg.org/v1.0.0/nn_socket.3.html>`_
+        """
         self.sock = nanomsg.nn_socket(domain, protocol)
 
     def close(self):