Enforce pre-summary newline in docstrings

This commit is contained in:
Dominik Muhs
2019-10-24 20:10:45 +02:00
parent 87ed98d7af
commit bafdd8512d
52 changed files with 349 additions and 199 deletions

View File

@ -27,7 +27,8 @@ logger = logging.getLogger("libp2p.network.basic_host")
class BasicHost(IHost):
"""BasicHost is a wrapper of a `INetwork` implementation.
"""
BasicHost is a wrapper of a `INetwork` implementation.
It performs protocol negotiation on a stream with multistream-select
right after a stream is initialized.
@ -87,7 +88,8 @@ class BasicHost(IHost):
def set_stream_handler(
self, protocol_id: TProtocol, stream_handler: StreamHandlerFn
) -> None:
"""set stream handler for given `protocol_id`
"""
set stream handler for given `protocol_id`
:param protocol_id: protocol id used on stream
:param stream_handler: a stream handler function
@ -119,7 +121,8 @@ class BasicHost(IHost):
return net_stream
async def connect(self, peer_info: PeerInfo) -> None:
"""connect ensures there is a connection between this host and the peer
"""
connect ensures there is a connection between this host and the peer
with given `peer_info.peer_id`. connect will absorb the addresses in
peer_info into its internal peerstore. If there is not an active
connection, connect will issue a dial, and block until a connection is