Update Pin.RmRecursive docs to clarify shared indirect pins are not removed

This commit was moved from ipfs/interface-go-ipfs-core@c908a059fe

This commit was moved from ipfs/boxo@ea26ae5e05
This commit is contained in:
Edgar Lee 2019-03-29 16:16:16 -07:00
parent 2817364035
commit 686f55459c

View File

@ -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