Update Pin.RmRecursive docs to clarify shared indirect pins are not removed
This commit was moved from ipfs/interface-go-ipfs-core@c908a059feab33b74ce66dca01fd521389372942 This commit was moved from ipfs/boxo@ea26ae5e0535dc2429c8c2797b79982317cc9bb3
Edgar Lee committed
Mar 29, 2019 at 16:16 UTC
686f55459c5747fac06c8b76810a371c9e635d9b
1 file changed
+3
-1
core/coreiface/options/pin.go
+3
-1
@@ -127,7 +127,9 @@ func (pinOpts) Recursive(recursive bool) PinAddOption {
127
}
128
}
129
130
-// RmRecursive is an option for Pin.Rm
130
+// RmRecursive is an option for Pin.Rm which specifies whether to recursively
131
+// unpin the object linked to by the specified object(s). This does not remove
132
+// indirect pins referenced by other recursive pins.
133
func (pinOpts) RmRecursive(recursive bool) PinRmOption {
134
return func(settings *PinRmSettings) error {
135
settings.Recursive = recursive