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

Commit b9e5a21

Browse files
authored
Merge pull request #303 from ipfs/JonKrone-patch-1
docs: pin.add, pin.rm are recursive by default
2 parents 1f0b72f + 5635d8e commit b9e5a21

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

SPEC/PIN.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Where:
1616

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

2121
`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:
2222

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

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

0 commit comments

Comments
 (0)