Unverified Commit c140b0fa authored by Łukasz Magiera's avatar Łukasz Magiera Committed by GitHub

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

Update Pin.RmRecursive docs to clarify shared indirect pins are not removed
parents 9ebc1123 c908a059
...@@ -127,7 +127,9 @@ func (pinOpts) Recursive(recursive bool) PinAddOption { ...@@ -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 { func (pinOpts) RmRecursive(recursive bool) PinRmOption {
return func(settings *PinRmSettings) error { return func(settings *PinRmSettings) error {
settings.Recursive = recursive settings.Recursive = recursive
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment