Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docstrings about relays #548

Merged
merged 4 commits into from
Jan 11, 2023
Merged

Fix docstrings about relays #548

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1b1cf7d
Fix docstrings about relays
borzunov Jan 11, 2023
ea09128
Update hivemind/p2p/p2p_daemon.py
borzunov Jan 11, 2023
109bfa1
Update run_dht.py
borzunov Jan 11, 2023
5e49850
Update run_server.py
borzunov Jan 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions hivemind/p2p/p2p_daemon.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,10 +130,10 @@ async def create(
:param use_ipfs: Bootstrap to IPFS (incompatible with initial_peers)
:param use_relay: Enable circuit relay functionality in libp2p
(see https://docs.libp2p.io/concepts/nat/circuit-relay/).
If enabled (default), others can use you as a relay.
If you want use relays yourself (to reach peers behind NATs/firewalls),
please also pass `use_auto_relay=True`.
:param use_auto_relay: Look for libp2p relays to reach peers behind NATs/firewalls
If enabled (default), you can reach peers behind NATs/firewalls through libp2p relays.
If you are behind NAT/firewall yourself,
please pass `use_auto_relay=True` to become reachable.
:param use_auto_relay: Look for libp2p relays to become reachable if this peer is behind NAT/firewall
borzunov marked this conversation as resolved.
Show resolved Hide resolved
:param quic: Deprecated, has no effect since libp2p 0.17.0
:param use_relay_hop: Deprecated, has no effect since libp2p 0.17.0
:param use_relay_discovery: Deprecated, has no effect since libp2p 0.17.0
Expand Down