From 78eac4e8f2dea3e4b4d7fbd2f1ad81abe94c17bc Mon Sep 17 00:00:00 2001
From: Virgil <virgil@lethean.io>
Date: Fri, 3 Apr 2026 10:56:05 +0000
Subject: [PATCH] docs(ansible): add AX usage examples

Co-Authored-By: Virgil <virgil@lethean.io>
---
 ssh.go   | 4 ++++
 types.go | 4 ++++
 2 files changed, 8 insertions(+)

diff --git a/ssh.go b/ssh.go
index 3813093..bd4e382 100644
--- a/ssh.go
+++ b/ssh.go
@@ -213,6 +213,10 @@ func (c *SSHClient) Close() error {
 }
 
 // BecomeState returns the current privilege escalation settings.
+//
+// Example:
+//
+//	become, user, password := client.BecomeState()
 func (c *SSHClient) BecomeState() (bool, string, string) {
 	c.mu.Lock()
 	defer c.mu.Unlock()
diff --git a/types.go b/types.go
index f11e4a2..4f310fc 100644
--- a/types.go
+++ b/types.go
@@ -491,6 +491,10 @@ var KnownModules = []string{
 
 // ModuleAliases maps accepted short-form module names to their canonical
 // fully-qualified collection names.
+//
+// Example:
+//
+//	module := ModuleAliases["ansible.builtin.authorized_key"]
 var ModuleAliases = map[string]string{
 	"authorized_key":                    "ansible.posix.authorized_key",
 	"ansible.builtin.authorized_key":    "ansible.posix.authorized_key",