Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

Commit

Permalink
Merge pull request #303 from ipfs/JonKrone-patch-1
Browse files Browse the repository at this point in the history
docs: pin.add, pin.rm are recursive by default
  • Loading branch information
alanshaw authored Jun 17, 2018
2 parents 1f0b72f + 5635d8e commit b9e5a21
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions SPEC/PIN.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Where:

- `hash` is an IPFS multihash.
- `options` is an object that can contain the following keys
- 'recursive' - Recursively pin the object linked. Type: bool. Default: `false`
- 'recursive' - Recursively pin the object linked. Type: bool. Default: `true`

`callback` must follow `function (err, res) {}` signature, where `err` is an error if the operation was not successful. `res` is an array of objects that represent the files that were pinned. Example:

Expand Down Expand Up @@ -76,7 +76,7 @@ A great source of [examples][] can be found in the tests for this API.
Where:
- `hash` is a multihash.
- `options` is an object that can contain the following keys
- 'recursive' - Recursively unpin the object linked. Type: bool. Default: `false`
- 'recursive' - Recursively unpin the object linked. Type: bool. Default: `true`

`callback` must follow `function (err) {}` signature, where `err` is an error if the operation was not successful.

Expand Down

0 comments on commit b9e5a21

Please sign in to comment.