Merge pull request #26 from hinshun/pin-rm-docs

Update Pin.RmRecursive docs to clarify shared indirect pins are not removed
ipfs · Apr 4, 2019 · c140b0f · c140b0f
2 parents 9ebc112 + c908a05
commit c140b0f
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/options/pin.go b/options/pin.go
@@ -127,7 +127,9 @@ func (pinOpts) Recursive(recursive bool) PinAddOption {
 	}
 }
 
-// RmRecursive is an option for Pin.Rm
+// RmRecursive is an option for Pin.Rm which specifies whether to recursively
+// unpin the object linked to by the specified object(s). This does not remove
+// indirect pins referenced by other recursive pins.
 func (pinOpts) RmRecursive(recursive bool) PinRmOption {
 	return func(settings *PinRmSettings) error {
 		settings.Recursive = recursive