Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pgeraghty committed Sep 26, 2019
1 parent c739633 commit e8b55a3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
4 changes: 4 additions & 0 deletions lib/ansible/ad_hoc.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 5 additions & 1 deletion lib/ansible/playbook.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit e8b55a3

Please sign in to comment.