Add documentation

lib/ansible/ad_hoc.rb

@@ -2,6 +2,7 @@
 require 'json'
 
 module Ansible
+  # Ansible Ad-Hoc methods
   module Methods
     # executable that runs Ansible Ad-Hoc commands
     BIN = 'ansible'
@@ -51,10 +52,12 @@ def parse_host_vars(host, inv, filter = 'hostvars[inventory_hostname]')
 
   # Provides static access to Ad-Hoc methods
   module AdHoc
-    include Ansible::Config
-    include Ansible::Methods
+    include Config
+    include Methods
 
     extend self
+
+    # @see Methods#one_off
     alias :run :one_off
   end
 end

lib/ansible/config.rb

@@ -6,6 +6,7 @@ module Config
     SKIP_HOSTVARS = %w(ansible_version inventory_dir inventory_file inventory_hostname inventory_hostname_short group_names groups omit playbook_dir)
     VERSION = `ansible --version`.split("\n").first.split.last rescue nil # nil when Ansible not installed
 
+    # Default configuration options
     DefaultConfig = Struct.new(:env, :extra_vars, :params) do
       # @!attribute env
       #   @return [Hash] environment variables
@@ -20,16 +21,16 @@ def initialize
           'ANSIBLE_HOST_KEY_CHECKING' => 'False'
         }
 
-        @params = {
-          debug: false
-        }
-
         @extra_vars = {
           # skip creation of .retry files
           'retry_files_enabled' => 'False'
         }
         # TODO support --ssh-common-args, --ssh-extra-args
         # e.g. ansible-playbook --ssh-common-args="-o ServerAliveInterval=60" -i inventory install.yml
+
+        @params = {
+          debug: false
+        }
       end
 
       # Pass additional options to Ansible

lib/ansible/playbook.rb

@@ -2,6 +2,7 @@
 require 'ansible/safe_pty'
 
 module Ansible
+  # Ansible Playbook methods
   module PlaybookMethods
     # executable that runs Ansible Playbooks
     BIN = 'ansible-playbook'