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

magik6k · web-flow · commit c140b0fa3831 · 2019-04-04T08:45:50.000+02:00
Update Pin.RmRecursive docs to clarify shared indirect pins are not removed
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

Original file line number	Diff line number	Diff line change
`@@ -127,7 +127,9 @@ func (pinOpts) Recursive(recursive bool) PinAddOption {`
`127`	`127`	`}`
`128`	`128`	`}`
`129`	`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.`
`131`	`133`	`func (pinOpts) RmRecursive(recursive bool) PinRmOption {`
`132`	`134`	`return func(settings *PinRmSettings) error {`
`133`	`135`	`settings.Recursive = recursive`