Merge pull request ipfs/boxoipfs/interface-go-ipfs-core#26 from hinshun/pin-rm-docs

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

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

This commit was moved from ipfs/boxo@25b9995074
This commit is contained in:
Łukasz Magiera 2019-04-04 08:45:50 +02:00 committed by GitHub
commit 6f77341fd6

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