From 7cbb53dbc8095f3f938884f59426848f5863e644 Mon Sep 17 00:00:00 2001 From: Virgil Date: Fri, 3 Apr 2026 12:19:47 +0000 Subject: [PATCH] refactor(ansible): document local client constructor --- local_client.go | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/local_client.go b/local_client.go index 5a1934c..a2d5932 100644 --- a/local_client.go +++ b/local_client.go @@ -14,6 +14,10 @@ import ( // localClient executes commands and file operations on the controller host. // It satisfies sshExecutorClient so the executor can reuse the same module // handlers for `connection: local` playbooks. +// +// Example: +// +// client := newLocalClient() type localClient struct { mu sync.Mutex become bool @@ -21,6 +25,11 @@ type localClient struct { becomePass string } +// newLocalClient creates a controller-side client for `connection: local`. +// +// Example: +// +// client := newLocalClient() func newLocalClient() *localClient { return &localClient{} }