From a6faf86ca4d4d4ce63c591698f4b5e5a5e5766a7 Mon Sep 17 00:00:00 2001 From: Edward McFarlane Date: Wed, 18 Dec 2024 20:53:43 +0100 Subject: [PATCH] Docs --- private/buf/bufctl/controller.go | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/private/buf/bufctl/controller.go b/private/buf/bufctl/controller.go index 52dd43f2bf..a287a7c88d 100644 --- a/private/buf/bufctl/controller.go +++ b/private/buf/bufctl/controller.go @@ -95,8 +95,9 @@ type Controller interface { // with a configured bufcheck Client. // // ImageWithConfig scopes the configuration per image for use with breaking - // and lint checks. The Client is bound to the input to ensure that the - // correct plugin dependencies are used. + // and lint checks. The check Client is bound to the input to ensure that the + // correct remote plugin dependencies are used. A wasmRuntime is provided + // to evaluate Wasm plugins. GetTargetImageWithConfigsAndCheckClient( ctx context.Context, input string, @@ -140,7 +141,8 @@ type Controller interface { // GetCheckClientForWorkspace returns a new bufcheck Client for the given Workspace. // // Clients are bound to a specific Workspace to ensure that the correct - // plugin dependencies are used. + // plugin dependencies are used. A wasmRuntime is provided to evaluate + // Wasm plugins. GetCheckClientForWorkspace( ctx context.Context, workspace bufworkspace.Workspace,