varun-r-mallya/py-libp2p
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/py-libp2p.git synced 2026-02-11 15:40:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

fixed doc comments in pubsub.abc

Browse Source
This commit is contained in:
mystical-prog
2024-11-30 18:44:49 +05:30
committed by Paul Robinson
parent f02d03844a
commit f156668c1b
2 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
libp2p/pubsub/abc.py
View File

@ -66,6 +66,7 @@ class IPubsubRouter(ABC):
Notifies the router that a new peer has been connected. Notifies the router that a new peer has been connected.
:param peer_id: id of peer to add :param peer_id: id of peer to add
:param protocol_id: router protocol the peer speaks, e.g., floodsub, gossipsub
""" """
@abstractmethod @abstractmethod
@ -81,10 +82,9 @@ class IPubsubRouter(ABC):
""" """
Invoked to process control messages in the RPC envelope. Invoked to process control messages in the RPC envelope.
It is invoked after subscriptions and payload messages have been processed It is invoked after subscriptions and payload messages have been processed
TODO: Check if this interface is ok. It's not the exact same as the go code, but
the go code is really confusing with the msg origin, they specify `rpc.from`
even when the rpc shouldn't have a from
:param rpc: rpc message :param rpc: rpc message
:param sender_peer_id: id of the peer who sent the message
""" """
@abstractmethod @abstractmethod

1
newsfragments/486.docs.rst Normal file
View File

@ -0,0 +1 @@
added missing details of params in ``IPubsubRouter``