documentation update

Author: jell-o-fishi

docs/api.rst

@@ -20,3 +20,25 @@ Handler
 
 .. automodule:: rsocket.request_handler
     :members:
+
+
+Interfaces
+----------
+
+Publisher
+~~~~~~~~~
+
+.. automodule:: reactivestreams.publisher
+    :members:
+
+Subscriber
+~~~~~~~~~~
+
+.. automodule:: reactivestreams.subscriber
+    :members:
+
+Subscription
+~~~~~~~~~~~~
+
+.. automodule:: reactivestreams.subscription
+    :members:

reactivestreams/publisher.py

@@ -4,6 +4,10 @@
 
 
 class Publisher(metaclass=abc.ABCMeta):
+    """
+    Handles event for subscription to a subscriber
+    """
+
     @abc.abstractmethod
     def subscribe(self, subscriber: Subscriber):
         ...

reactivestreams/subscriber.py

@@ -5,6 +5,10 @@
 
 
 class Subscriber(metaclass=ABCMeta):
+    """
+    Handles stream events.
+    """
+
     @abstractmethod
     def on_subscribe(self, subscription: Subscription):
         ...

reactivestreams/subscription.py

@@ -2,6 +2,10 @@
 
 
 class Subscription(metaclass=ABCMeta):
+    """
+    Backpressure stream control.
+    """
+
     @abstractmethod
     def request(self, n: int):
         ...

rsocket/rsocket_client.py

@@ -18,6 +18,9 @@
 
 
 class RSocketClient(RSocketBase):
+    """
+    Server side instance of an rsocket connection.
+    """
 
     def __init__(self,
                  transport_provider: AsyncGenerator[Transport, Any],

rsocket/rsocket_server.py

@@ -15,6 +15,7 @@ class RSocketServer(RSocketBase):
     """
     Server side instance of an rsocket connection.
     """
+
     def __init__(self,
                  transport: Transport,
                  handler_factory: Callable[[], RequestHandler] = BaseRequestHandler,