From 0542809e9024bef6d5f2bdc732e4f68429fd9236 Mon Sep 17 00:00:00 2001 From: jaredoconnell Date: Fri, 8 Sep 2023 16:17:51 -0400 Subject: [PATCH] Update comment describing meaning of context cancelled --- interface.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/interface.go b/interface.go index d0e103e..8a9b280 100644 --- a/interface.go +++ b/interface.go @@ -33,8 +33,8 @@ type Connector interface { // // Parameters: // ctx: The context that lasts the length of the deployment. - // Cancelling the context will send a SIGTERM request to terminate the deployment, - // which can be used to cancel the running step. + // A cancelled context means the plugin is in the process of getting shut down, or is shut down. No new + // deployment should be allowed. // pluginSource: The source of the plugin. This can be the tag of the image to run, a Python module, or // anything else that the deployer supports. Deploy(ctx context.Context, pluginSource string) (Plugin, error)