daemon: deprecate Daemon.IsPaused

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 <[email protected]>
thaJeztah · Oct 21, 2024 · ac6e32c · ac6e32c
1 parent d47c31f
commit ac6e32c
Showing 1 changed file with 2 additions and 0 deletions.
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()