daemon: deprecate Daemon.IsPaused

thaJeztah · thaJeztah · commit ac6e32cb5c2c · 2024-10-21T13:22:02.000+02:00
This function was poorly documented as it uses fuzzy matching under the hood,
and it's no longer used. Mark it as deprecated, and to be removed in the
next release.

Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/daemon/container.go b/daemon/container.go
@@ -78,6 +78,8 @@ func (daemon *Daemon) Exists(id string) bool {
 }
 
 // IsPaused returns a bool indicating if the specified container is paused.
+//
+// Deprecated: use [Daemon.GetContainer] to look up a container by ID, Name, or ID-prefix, and use [container.State.IsPaused]. This function will be removed in the next release.
 func (daemon *Daemon) IsPaused(id string) bool {
 	c, _ := daemon.GetContainer(id)
 	return c.State.IsPaused()

Original file line number	Diff line number	Diff line change
`@@ -78,6 +78,8 @@ func (daemon *Daemon) Exists(id string) bool {`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`// IsPaused returns a bool indicating if the specified container is paused.`
	`81`	`+//`
	`82`	`+// Deprecated: use [Daemon.GetContainer] to look up a container by ID, Name, or ID-prefix, and use [container.State.IsPaused]. This function will be removed in the next release.`
`81`	`83`	`func (daemon *Daemon) IsPaused(id string) bool {`
`82`	`84`	`c, _ := daemon.GetContainer(id)`
`83`	`85`	`return c.State.IsPaused()`