From bac26ea3da19b12f605f6e667ac723a80068f0fd Mon Sep 17 00:00:00 2001
From: Franck Royer <franck@status.im>
Date: Wed, 11 Aug 2021 10:32:15 +1000
Subject: [PATCH] fixup

---
 src/lib/discovery.ts | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/lib/discovery.ts b/src/lib/discovery.ts
index f631909922..4999bdcb33 100644
--- a/src/lib/discovery.ts
+++ b/src/lib/discovery.ts
@@ -10,7 +10,9 @@ const dbg = debug('waku:discovery');
  *
  * @param path The property path to access the node list. The result should be
  * a string, a string array or an object. If the result is an object then the
- * values of the objects are used as multiaddresses.
+ * values of the objects are used as multiaddresses. For example, if the GET
+ * request returns `{ foo: { bar: [address1, address2] } }` then `path` should be
+ * `[ "foo", "bar" ]`.
  * @param url Remote host containing bootstrap peers in JSON format.
  *
  * @returns An array of multiaddresses.