From af91b3bb2f8384d27b232004a156933ed7e84356 Mon Sep 17 00:00:00 2001 From: Brian Cain Date: Mon, 8 Oct 2018 09:47:03 -0700 Subject: [PATCH] Add more information about Ruby trigger option This commit provides a bit more context to using the new Ruby trigger option. --- website/source/docs/triggers/configuration.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/source/docs/triggers/configuration.html.md b/website/source/docs/triggers/configuration.html.md index 01d334c2e..a3569ef08 100644 --- a/website/source/docs/triggers/configuration.html.md +++ b/website/source/docs/triggers/configuration.html.md @@ -34,7 +34,7 @@ The trigger class takes various options. * `only_on` (string, regex, array) - Limit the trigger to these guests. Values can be a string or regex that matches a guest name. -* `ruby` (block) - A block of Ruby code to be executed. Can only be a `Proc` type. Two optional arguments may be passed into the given block: `env` and `machine`. These options correspond to the environment used, and the machine that the trigger is firing on. If no options are provided to the block, then they will not be available to be used with your Ruby code. +* `ruby` (block) - A block of Ruby code to be executed on the host. The block accepts two arguments that can be used with your Ruby code: `env` and `machine`. These options correspond to the Vagrant environment used (note: these are not your shell's environment variables), and the Vagrant guest machine that the trigger is firing on. This option can only be a `Proc` type, which must be explicitly called out when using the hash syntax for a trigger. ```ruby ubuntu.trigger.after :up do |trigger|