[Pkg-puppet-devel] [SCM] Puppet packaging for Debian branch, experimental, updated. debian/2.6.8-1-844-g7ec39d5

Daniel Pittman daniel at puppetlabs.com
Tue May 10 08:19:15 UTC 2011


The following commit has been merged in the experimental branch:
commit 5490f7aee19f477914520f0735858f58136122e4
Author: Daniel Pittman <daniel at puppetlabs.com>
Date:   Tue May 3 14:38:57 2011 -0700

    (#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 at puppetlabs.com>

diff --git a/lib/puppet/interface/action.rb b/lib/puppet/interface/action.rb
index 203d808..d4cf23f 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}")

-- 
Puppet packaging for Debian



More information about the Pkg-puppet-devel mailing list