From 043fb3472133e59fd1b82920572702cfd2c77d02 Mon Sep 17 00:00:00 2001 From: Charlie Sharpsteen Date: Sat, 31 May 2014 23:24:27 -0700 Subject: [PATCH] Add docstrings to yardoc face --- lib/puppet/face/yardoc.rb | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/puppet/face/yardoc.rb b/lib/puppet/face/yardoc.rb index ce6f09c..6b50985 100644 --- a/lib/puppet/face/yardoc.rb +++ b/lib/puppet/face/yardoc.rb @@ -1,10 +1,14 @@ require 'puppet/face' Puppet::Face.define(:yardoc, '0.0.1') do + summary "Generate Puppet documentation with YARD." action(:yardoc) do default + summary "Generate module documentation." + arguments "[manifest_file.pp ...]" + when_invoked do |*args| unless Puppet.features.yard? raise RuntimeError, "The 'yard' gem must be installed in order to use this face."