From fab0ee0f5a275a8cd03ee5ebfdfeff5dd7274111 Mon Sep 17 00:00:00 2001
From: Alan Shaw <alan@tableflip.io>
Date: Tue, 28 Aug 2018 13:02:57 +0100
Subject: [PATCH 1/2] fix: bitswap.stat docs

Fixes description, return types and example.

License: MIT
Signed-off-by: Alan Shaw <alan@tableflip.io>
---
 SPEC/BITSWAP.md | 12 ++++++------
 SPEC/STATS.md   |  8 ++++++--
 2 files changed, 12 insertions(+), 8 deletions(-)

diff --git a/SPEC/BITSWAP.md b/SPEC/BITSWAP.md
index d1fb06146..c50093e41 100644
--- a/SPEC/BITSWAP.md
+++ b/SPEC/BITSWAP.md
@@ -32,19 +32,19 @@ ipfs.bitswap.wantlist(peerId, (err, list) => console.log(list))
 
 #### `bitswap.stat`
 
-> Adds an IPFS object to the pinset and also stores it to the IPFS repo. pinset is the set of hashes currently pinned (not gc'able).
+> Show diagnostic information on the bitswap agent.
 
 ##### `Go` **WIP**
 
 ##### `JavaScript` - ipfs.bitswap.stat([callback])
 
-`stats.bitswap` and `bitswap.stat` can be used interchangeably.
+Note: `bitswap.stat` and `stats.bitswap` can be used interchangeably.
 
 `callback` must follow `function (err, stats) {}` signature, where `err` is an error if the operation was not successful. `stats` is an Object containing the following keys:
 
 - `provideBufLen` is an integer.
-- `wantlist` (array)
-- `peers` (array)
+- `wantlist` (array of CIDs)
+- `peers` (array of peer IDs)
 - `blocksReceived` is a [Big Int][1]
 - `dataReceived` is a [Big Int][1]
 - `blocksSent` is a [Big Int][1]
@@ -57,10 +57,10 @@ If no `callback` is passed, a promise is returned.
 **Example:**
 
 ```JavaScript
-ipfs.stats.bitswap((err, stats) => console.log(stats))
+ipfs.bitswap.stat((err, stats) => console.log(stats))
 
 // { provideBufLen: 0,
-//   wantlist: null,
+//   wantlist: [ { '/': 'QmSoLPppuBtQSGwKDZT2M73ULpjvfd3aZ6ha4oFGL1KrGM' } ],
 //   peers:
 //    [ 'QmSoLPppuBtQSGwKDZT2M73ULpjvfd3aZ6ha4oFGL1KrGM',
 //      'QmSoLSafTMBsPKadTEgaXctDQVcqN88CNLHXMkTNwMKPnu',
diff --git a/SPEC/STATS.md b/SPEC/STATS.md
index ee87bda6d..def4c5224 100644
--- a/SPEC/STATS.md
+++ b/SPEC/STATS.md
@@ -8,11 +8,15 @@
 
 #### `stats.bitswap`
 
-`stats.bitswap` and `bitswap.stat` can be used interchangeably. See [`bitswap.stat`](./BITSWAP.md#stat) for more details.
+> Show diagnostic information on the bitswap agent.
+
+Note: `stats.bitswap` and `bitswap.stat` can be used interchangeably. See [`bitswap.stat`](./BITSWAP.md#bitswap.stat) for more details.
 
 #### `stats.repo`
 
-`stats.repo` and `repo.stat` can be used interchangeably. See [`repo.stat`](./REPO.md#stat) for more details.
+> Get stats for the currently used repo.
+
+Note: `stats.repo` and `repo.stat` can be used interchangeably. See [`repo.stat`](./REPO.md#repo.stat) for more details.
 
 #### `stats.bw`
 

From 05641ef4a938f7860ecd3e3d9ca110df3c3b287a Mon Sep 17 00:00:00 2001
From: Alan Shaw <alan@tableflip.io>
Date: Tue, 28 Aug 2018 13:05:13 +0100
Subject: [PATCH 2/2] fix: links to bitswap and repo

License: MIT
Signed-off-by: Alan Shaw <alan@tableflip.io>
---
 SPEC/STATS.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/SPEC/STATS.md b/SPEC/STATS.md
index def4c5224..58b0c7370 100644
--- a/SPEC/STATS.md
+++ b/SPEC/STATS.md
@@ -10,13 +10,13 @@
 
 > Show diagnostic information on the bitswap agent.
 
-Note: `stats.bitswap` and `bitswap.stat` can be used interchangeably. See [`bitswap.stat`](./BITSWAP.md#bitswap.stat) for more details.
+Note: `stats.bitswap` and `bitswap.stat` can be used interchangeably. See [`bitswap.stat`](./BITSWAP.md#bitswapstat) for more details.
 
 #### `stats.repo`
 
 > Get stats for the currently used repo.
 
-Note: `stats.repo` and `repo.stat` can be used interchangeably. See [`repo.stat`](./REPO.md#repo.stat) for more details.
+Note: `stats.repo` and `repo.stat` can be used interchangeably. See [`repo.stat`](./REPO.md#repostat) for more details.
 
 #### `stats.bw`