diff options
| author | nfagerlund <nick.fagerlund@gmail.com> | 2011-06-08 15:04:51 -0700 |
|---|---|---|
| committer | nfagerlund <nick.fagerlund@gmail.com> | 2011-06-08 15:46:04 -0700 |
| commit | f370d5a9e2587c067c458eca65198dbf90c800a6 (patch) | |
| tree | d61c1607a92079aef3c2a08f1968eed2fa3a4cc6 /lib/puppet/face/help | |
| parent | 90d2cf0a7b2f3fc0d16f07abb11e204dc1ed0028 (diff) | |
| download | puppet-f370d5a9e2587c067c458eca65198dbf90c800a6.tar.gz puppet-f370d5a9e2587c067c458eca65198dbf90c800a6.tar.xz puppet-f370d5a9e2587c067c458eca65198dbf90c800a6.zip | |
(#7833) Several help text/template edits
This commit makes the following changes:
* Changes wrapping on some "returns" blocks to accomodate the way we prepend
"RETURNS: " to the first line in short help.
* Overrides description for save on faces where save is invalid. (Since save has
an inherited description, the description was contradicting the summary.)
* Adds notes on dummy arguments to short_description where applicable, so as to
show up in short help.
* Adds the termini list to the action short help template.
* Removes the authors block from short help for faces. (Save it for the man page.)
* Several trivial wording changes.
Reviewed-By: Jacob Helwig <jacob@puppetlabs.com>
Diffstat (limited to 'lib/puppet/face/help')
| -rw-r--r-- | lib/puppet/face/help/action.erb | 4 | ||||
| -rw-r--r-- | lib/puppet/face/help/face.erb | 5 |
2 files changed, 4 insertions, 5 deletions
diff --git a/lib/puppet/face/help/action.erb b/lib/puppet/face/help/action.erb index 5242ed218..c84e46cf9 100644 --- a/lib/puppet/face/help/action.erb +++ b/lib/puppet/face/help/action.erb @@ -46,4 +46,8 @@ undocumented option end -%> <% end -%> +<% if face.respond_to? :indirection -%> +TERMINI: <%= face.class.terminus_classes(face.indirection.name).join(", ") %> + +<% end -%> See 'puppet man <%= face.name %>' or 'man puppet-<%= face.name %>' for full help. diff --git a/lib/puppet/face/help/face.erb b/lib/puppet/face/help/face.erb index 870cc547f..255d3d55b 100644 --- a/lib/puppet/face/help/face.erb +++ b/lib/puppet/face/help/face.erb @@ -75,10 +75,5 @@ end -%> <% if face.respond_to? :indirection -%> TERMINI: <%= face.class.terminus_classes(face.indirection.name).join(", ") %> -<% end - unless face.authors.empty? -%> -AUTHOR -<%= face.authors.join("\n").gsub(/^/, ' * ') %> - <% end -%> See 'puppet man <%= face.name %>' or 'man puppet-<%= face.name %>' for full help. |