diff options
| author | Daniel Pittman <daniel@puppetlabs.com> | 2011-04-27 10:05:48 -0700 |
|---|---|---|
| committer | Daniel Pittman <daniel@puppetlabs.com> | 2011-04-27 10:10:20 -0700 |
| commit | e8eb290a1681baa19ef0b035af7cf17daadc6069 (patch) | |
| tree | e94d133c7a817be600fa38902fdc96cc304b3670 /lib/puppet/face/help | |
| parent | 6e152ad1d0bb34f6d24fd818b2b020d5a8dd385b (diff) | |
| download | puppet-e8eb290a1681baa19ef0b035af7cf17daadc6069.tar.gz puppet-e8eb290a1681baa19ef0b035af7cf17daadc6069.tar.xz puppet-e8eb290a1681baa19ef0b035af7cf17daadc6069.zip | |
(#6962) Finish documentation API on Face options.
This extends the last of the documentation support, down into options, so they
can be described as expected. In the process we split out the modular docs
API into a full and short version options only want short docs, but the
behaviours are identical to the full version.
Diffstat (limited to 'lib/puppet/face/help')
| -rw-r--r-- | lib/puppet/face/help/action.erb | 3 | ||||
| -rw-r--r-- | lib/puppet/face/help/face.erb | 3 |
2 files changed, 4 insertions, 2 deletions
diff --git a/lib/puppet/face/help/action.erb b/lib/puppet/face/help/action.erb index 7a9b87117..c26958a35 100644 --- a/lib/puppet/face/help/action.erb +++ b/lib/puppet/face/help/action.erb @@ -20,7 +20,8 @@ OPTIONS % action.options.sort.each do |name| % option = action.get_option name <%= " " + option.optparse.join(" |" ) %> -<%= option.desc and option.desc.gsub(/^/, ' ') %> +<%= option.summary %> +<%= option.description %> % end % end diff --git a/lib/puppet/face/help/face.erb b/lib/puppet/face/help/face.erb index 944f7a96b..b249981de 100644 --- a/lib/puppet/face/help/face.erb +++ b/lib/puppet/face/help/face.erb @@ -16,7 +16,8 @@ OPTIONS % face.options.sort.each do |name| % option = face.get_option name <%= " " + option.optparse.join(" |" ) %> -<%= option.desc and option.desc.gsub(/^/, ' ') %> +<%= option.summary %> +<%= option.description %> % end % end |