From 5635d8efbf8d0e1b6b2a24037da1ec23237e29dc Mon Sep 17 00:00:00 2001 From: Jonathan Date: Thu, 14 Jun 2018 13:32:24 -0500 Subject: [PATCH] [DOC] pin.add, pin.rm are recursive by default Current and expected behavior of pin.add, pin.rm is to be recursive by default. --- SPEC/PIN.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/SPEC/PIN.md b/SPEC/PIN.md index bc0aeeb1..1f27b140 100644 --- a/SPEC/PIN.md +++ b/SPEC/PIN.md @@ -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: @@ -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.