diff options
| author | Daniel Pittman <daniel@puppetlabs.com> | 2011-05-03 14:38:57 -0700 |
|---|---|---|
| committer | Daniel Pittman <daniel@puppetlabs.com> | 2011-05-03 14:54:30 -0700 |
| commit | 5490f7aee19f477914520f0735858f58136122e4 (patch) | |
| tree | 0af43b081031d73c44aa33fca23fe0429920fc88 | |
| parent | 0d6ac040f4223725586c2b5d71ffcb0d36206080 (diff) | |
| download | puppet-5490f7aee19f477914520f0735858f58136122e4.tar.gz puppet-5490f7aee19f477914520f0735858f58136122e4.tar.xz puppet-5490f7aee19f477914520f0735858f58136122e4.zip | |
(#6962) Added 'returns' block to action documentation.
We want to be able to document the data returned from an action, since this is
one of the most critical parts of the API for Ruby developers. This adds a
multiline documentation block that captures that.
Reviewed-By: Pieter van de Bruggen <pieter@puppetlabs.com>
| -rw-r--r-- | lib/puppet/interface/action.rb | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/lib/puppet/interface/action.rb b/lib/puppet/interface/action.rb index 203d80827..d4cf23fce 100644 --- a/lib/puppet/interface/action.rb +++ b/lib/puppet/interface/action.rb @@ -3,6 +3,7 @@ require 'puppet/interface/documentation' require 'prettyprint' class Puppet::Interface::Action + extend Puppet::Interface::DocGen include Puppet::Interface::FullDocs def initialize(face, name, attrs = {}) @@ -44,6 +45,7 @@ class Puppet::Interface::Action ######################################################################## # Documentation... + attr_doc :returns def synopsis output = PrettyPrint.format do |s| s.text("puppet #{@face.name}") |