From 30263333cd30e40468d02e5cc77a0253415cf3e2 Mon Sep 17 00:00:00 2001 From: nfagerlund Date: Wed, 18 May 2011 16:20:05 -0700 Subject: (#7561) Complete help text for all faces and actions Faces help output relies on input from the documentation methods in each of the faces to be documented. This commit calls those methods in each of our faces, with varying levels of detail depending on their complexity. --- lib/puppet/face/help.rb | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'lib/puppet/face/help.rb') diff --git a/lib/puppet/face/help.rb b/lib/puppet/face/help.rb index aef917447..7a382b8c9 100644 --- a/lib/puppet/face/help.rb +++ b/lib/puppet/face/help.rb @@ -7,13 +7,20 @@ Puppet::Face.define(:help, '0.0.1') do copyright "Puppet Labs", 2011 license "Apache 2 license; see COPYING" - summary "Displays help about puppet subcommands" + summary "Display Puppet help." action(:help) do summary "Display help about faces and their actions." + arguments "[] []" + returns "Short help text for the specified face or action." + examples <<-'EOT' + Get help for an action: + + $ puppet help + EOT option "--version VERSION" do - summary "which version of the interface to show help for" + summary "The version of the face for which to show help." end default -- cgit