Merge pull request #835 from libp2p/fix/autorelay-doc

doc(options): fix autorelay documentation
libp2p · Mar 9, 2020 · 4bbf43e · 4bbf43e
2 parents 6163463 + 8248da9
commit 4bbf43e
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/options.go b/options.go
@@ -228,9 +228,11 @@ func DisableRelay() Option {
 	}
 }
 
-// EnableAutoRelay configures libp2p to enable the AutoRelay subsystem. It is an
-// error to enable AutoRelay without enabling relay (enabled by default) and
-// routing (not enabled by default).
+// EnableAutoRelay configures libp2p to enable the AutoRelay subsystem.
+//
+// Dependencies:
+//  * Relay (enabled by default)
+//  * Routing (to find relays), or StaticRelays/DefaultStaticRelays.
 //
 // This subsystem performs two functions:
 //