chore: apply suggestions from code review

Co-Authored-By: Jacob Heun <[email protected]>
libp2p · Apr 24, 2020 · 3d6c5a8 · 3d6c5a8
1 parent 7039cd0
commit 3d6c5a8
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/src/index.js b/src/index.js
@@ -267,7 +267,7 @@ class Libp2p extends EventEmitter {
   }
 
   /**
-   * Dials to the provided peer. If successful, the known `Peer` data of the
+   * Dials to the provided peer. If successful, the known metadata of the
    * peer will be added to the nodes `peerStore`
    * @param {PeerId|Multiaddr|string} peer The peer to dial
    * @param {object} options
@@ -280,7 +280,7 @@ class Libp2p extends EventEmitter {
 
   /**
    * Dials to the provided peer and handshakes with the given protocol.
-   * If successful, the known `Peer` data of the peer will be added to the nodes `peerStore`,
+   * If successful, the known metadata of the peer will be added to the nodes `peerStore`,
    * and the `Connection` will be returned
    * @async
    * @param {PeerId|Multiaddr|string} peer The peer to dial
@@ -422,7 +422,7 @@ class Libp2p extends EventEmitter {
    * Called whenever peer discovery services emit `peer` events.
    * Known peers may be emitted.
    * @private
-   * @param {PeerDara} peer
+   * @param {{ id: PeerId, multiaddrs: Array<Multiaddr>, protocols: Array<string> }} peer
    */
   _onDiscoveryPeer (peer) {
     if (peer.id.toB58String() === this.peerId.toB58String()) {

diff --git a/src/peer-store/README.md b/src/peer-store/README.md
@@ -42,7 +42,7 @@ The `addressBook` keeps the known multiaddrs of a peer. The multiaddrs of each p
 
 `Map<string, Address>`
 
-A `peerId.toString()` identifier mapping to a `Address` object, which should have the following structure:
+A `peerId.toString()` identifier mapping to an `Address` object, which should have the following structure:
 
 ```js
 {