From e8b55a3693753a47d4530ae935f49cba93ce904f Mon Sep 17 00:00:00 2001 From: Paul Geraghty Date: Thu, 26 Sep 2019 21:40:54 +0200 Subject: [PATCH] Add documentation --- lib/ansible/ad_hoc.rb | 4 ++++ lib/ansible/playbook.rb | 6 +++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/lib/ansible/ad_hoc.rb b/lib/ansible/ad_hoc.rb index 85044dd..6eb28a0 100644 --- a/lib/ansible/ad_hoc.rb +++ b/lib/ansible/ad_hoc.rb @@ -57,7 +57,11 @@ module AdHoc extend self + # Run an Ad-Hoc Ansible command # @see Methods#one_off + # @param cmd [String] the Ansible command to execute + # @return [String] the output + # @since 0.2.1 alias :run :one_off end end \ No newline at end of file diff --git a/lib/ansible/playbook.rb b/lib/ansible/playbook.rb index cf13ca4..af342e8 100644 --- a/lib/ansible/playbook.rb +++ b/lib/ansible/playbook.rb @@ -7,7 +7,7 @@ module PlaybookMethods # executable that runs Ansible Playbooks BIN = 'ansible-playbook' - # Execute playbook, returning output + # Run playbook, returning output # @param pb [String] path to playbook # @return [String] output def playbook(pb) @@ -41,6 +41,10 @@ module Playbook include PlaybookMethods extend self + + # Run playbook, returning output + # @param pb [String] path to playbook + # @return [String] output alias :run :playbook # Exception to represent Playbook failures