Update trigger docs

This commit is contained in:
Brian Cain 2018-04-05 13:56:21 -07:00
parent 4e5e4d0214
commit 6f2b5a9fa0
No known key found for this signature in database
GPG Key ID: 43D51080D357A001
2 changed files with 4 additions and 5 deletions

View File

@ -15,8 +15,7 @@ trigger should behave.
The trigger class takes various options. The trigger class takes various options.
* `action` (symbol) - The first argument that comes after either __before__ or __after__ when defining a new trigger (For example when the action is `:up` : `config.trigger.before :up`). * `action` (symbol, array) - Expected to be a single symbol value, an array of symbols, or a _splat_ of symbols. The first argument that comes after either __before__ or __after__ when defining a new trigger. Can be any valid Vagrant command. It also accepts a special value `:all` which will make the trigger fire for every action. An action can be ignored with the `ignore` setting if desired.
Can be any valid Vagrant command. It also accepts a special value `:all` which will make the trigger fire for every action. An action can be ignored with the `ignore` setting if desired.
* `ignore` (symbol, array) - Symbol or array of symbols corresponding to the action that a trigger should not fire on. * `ignore` (symbol, array) - Symbol or array of symbols corresponding to the action that a trigger should not fire on.

View File

@ -34,9 +34,9 @@ end
``` ```
Alternatively, the key `:all` could be given which would run the trigger for every Alternatively, the key `:all` could be given which would run the trigger for every
Vagrant command. This trigger will run before or after every Vagrant command. Vagrant command. This trigger will run before or after every Vagrant command. If
This must include the ability to blacklist a command so that the trigger isnt there is a command you don't want the trigger to run on, you can ignore that
run. The blacklist will be defined within the `:all` config block. command with the `ignore` option.
```ruby ```ruby
# single command trigger # single command trigger