doc(transport.driver_base): Add docstrings

Also, renamed driver_base to base.py to be consistent with storage.

Change-Id: Iff59699a7c43341c2069823a8f39373c2d6b4760
Implements: blueprint transport-base
This commit is contained in:
Kurt Griffiths 2013-03-08 15:43:12 -05:00
parent 1778a07fb9
commit 42e40d531c
2 changed files with 7 additions and 3 deletions

View File

@ -1,3 +1,3 @@
"""Marconi Transport Drivers"""
from marconi.transport.driver_base import DriverBase # NOQA
from marconi.transport.base import DriverBase # NOQA

View File

@ -17,10 +17,14 @@ import abc
class DriverBase:
"""Base class for Transport Drivers to document the expected interface."""
__metaclass__ = abc.ABCMeta
@abc.abstractmethod
def listen():
#TODO(kgriffs): If this is all there is to DriverBase, do we
# even need it?
"""
Called to start listening for client requests when Marconi is
ran in self-hosting mode.
"""
pass