(#6962) Add self-documentation data to puppet faces

This patch adds documentation strings to most of the faces, actions, and options
introduced in 2.7.0. There are a small number of TK notes remaining, and longer strings
have not been indented to take advantage of the patch from issue #7221.

1 files changed, 16 insertions, 0 deletions

diff --git a/lib/puppet/face/catalog/select.rb b/lib/puppet/face/catalog/select.rb
index a68a8e0f3..c5d37eb66 100644
--- a/lib/puppet/face/catalog/select.rb
+++ b/lib/puppet/face/catalog/select.rb
@@ -1,6 +1,22 @@
 # Select and show a list of resources of a given type.
 Puppet::Face.define(:catalog, '0.0.1') do
   action :select do
+    summary "Select and show a list of resources of a given type"
+    description <<-EOT
+Retrieves a catalog for the specified host and returns an array of
+resources of the given type. This action is not intended for
+command-line use.
+    EOT
+    notes <<-NOTES
+The type name for this action must be given in its capitalized form.
+That is, calling `catalog select mynode file` will return an empty
+array, whereas calling it with 'File' will return a list of the node's
+file resources.
+
+By default, this action will retrieve a catalog from Puppet's compiler
+subsystem; you must call the action with `--terminus rest` if you wish
+to retrieve a catalog from the puppet master.
+    NOTES
     when_invoked do |host, type, options|
       # REVISIT: Eventually, type should have a default value that triggers
       # the non-specific behaviour.  For now, though, this will do.