Skip to content
This repository has been archived by the owner on Mar 10, 2020. It is now read-only.

Commit

Permalink
fix: example links in miscellaneous spec section (#364)
Browse files Browse the repository at this point in the history
- fix broken link for version example
- make all links more specific
  • Loading branch information
olizilla authored and alanshaw committed Sep 18, 2018
1 parent 41cf3a5 commit 45e8142
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions SPEC/MISCELLANEOUS.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ ipfs.id(function (err, identity) {
})
```

A great source of [examples][] can be found in the tests for this API.
A great source of [examples](https://github.com/ipfs/interface-ipfs-core/blob/master/js/src/miscellaneous/id.js) can be found in the tests for this API.

#### `version`

Expand All @@ -57,7 +57,7 @@ ipfs.version((err, version) => {
})
```

A great source of [examples][] can be found in the tests for this API.
A great source of [examples](https://github.com/ipfs/interface-ipfs-core/blob/master/js/src/miscellaneous/version.js) can be found in the tests for this API.

#### `dns`

Expand All @@ -82,9 +82,7 @@ ipfs.dns('ipfs.io', (err, path) => {
})
```

A great source of [examples][] can be found in the tests for this API.

[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/js/src/miscellaneous.js
A great source of [examples](https://github.com/ipfs/interface-ipfs-core/blob/master/js/src/miscellaneous/dns.js) can be found in the tests for this API.

#### `stop`

Expand All @@ -107,7 +105,7 @@ ipfs.stop((err) => {
})
```

A great source of [examples][] can be found in the tests for this API.
A great source of [examples](https://github.com/ipfs/interface-ipfs-core/blob/master/js/src/miscellaneous/stop.js) can be found in the tests for this API.

#### `ping`

Expand Down Expand Up @@ -154,7 +152,7 @@ ipfs.ping('Qmhash', function (err, responses) {
})
```

A great source of [examples][] can be found in the tests for this API.
A great source of [examples](https://github.com/ipfs/interface-ipfs-core/tree/master/js/src/ping) can be found in the tests for this API.

#### `pingPullStream`

Expand Down Expand Up @@ -199,7 +197,7 @@ pull(
)
```

A great source of [examples][] can be found in the tests for this API.
A great source of [examples](https://github.com/ipfs/interface-ipfs-core/tree/master/js/src/ping) can be found in the tests for this API.

#### `pingReadableStream`

Expand Down Expand Up @@ -241,7 +239,7 @@ stream.on('data', (res) => {
})
```

A great source of [examples][] can be found in the tests for this API.
A great source of [examples](https://github.com/ipfs/interface-ipfs-core/tree/master/js/src/ping) can be found in the tests for this API.

#### `resolve`

Expand Down Expand Up @@ -311,7 +309,7 @@ ipfs.resolve(name, (err, res) => {
})
```

A great source of [examples][] can be found in the tests for this API.
A great source of [examples](https://github.com/ipfs/interface-ipfs-core/blob/master/js/src/miscellaneous/resolve.js) can be found in the tests for this API.

[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/js/src/miscellaneous
[rs]: https://www.npmjs.com/package/readable-stream
Expand Down

0 comments on commit 45e8142

Please sign in to comment.