varun-r-mallya/py-libp2p
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/py-libp2p.git synced 2026-03-21 20:51:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enforce pre-summary newline in docstrings

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

9
libp2p/__init__.py
View File

@ -48,7 +48,8 @@ def generate_peer_id_from(key_pair: KeyPair) -> ID:
def initialize_default_kademlia_router(
ksize: int = 20, alpha: int = 3, id_opt: ID = None, storage: IStorage = None
) -> KadmeliaPeerRouter:
"""initialize kadmelia router when no kademlia router is passed in.
"""
initialize kadmelia router when no kademlia router is passed in.
:param ksize: The k parameter from the paper
:param alpha: The alpha parameter from the paper
@ -78,7 +79,8 @@ def initialize_default_swarm(
peerstore_opt: IPeerStore = None,
disc_opt: IPeerRouting = None,
) -> Swarm:
"""initialize swarm when no swarm is passed in.
"""
initialize swarm when no swarm is passed in.
:param id_opt: optional id for host
:param transport_opt: optional choice of transport upgrade
@ -118,7 +120,8 @@ async def new_node(
peerstore_opt: IPeerStore = None,
disc_opt: IPeerRouting = None,
) -> IHost:
"""create new libp2p node.
"""
create new libp2p node.
:param key_pair: key pair for deriving an identity
:param swarm_opt: optional swarm