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/parser.rb | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'lib/puppet/face/parser.rb') diff --git a/lib/puppet/face/parser.rb b/lib/puppet/face/parser.rb index e6a9503dd..8dd3efb75 100644 --- a/lib/puppet/face/parser.rb +++ b/lib/puppet/face/parser.rb @@ -5,11 +5,13 @@ Puppet::Face.define(:parser, '0.0.1') do copyright "Puppet Labs", 2011 license "Apache 2 license; see COPYING" - summary "Interact directly with the parser" + summary "Interact directly with the parser." action :validate do - summary "Validate the syntax of one or more Puppet manifests" - description <<-EOT + summary "Validate the syntax of one or more Puppet manifests." + arguments "[] [ ...]" + returns "Nothing, or the first syntax error encountered." + description <<-'EOT' This action validates Puppet DSL syntax without compiling a catalog or syncing any resources. If no manifest files are provided, it will validate the default site manifest. -- cgit