summaryrefslogtreecommitdiffstats
path: root/lib/puppet/interface/documentation.rb
diff options
context:
space:
mode:
authornfagerlund <nick.fagerlund@gmail.com>2011-05-23 17:26:59 -0700
committernfagerlund <nick.fagerlund@gmail.com>2011-05-26 10:07:40 -0700
commit13e473ed3c2dc53772e75bcb9822b725cf9f8a79 (patch)
tree872667e85762d67a09585d0a75d9730f16f72ad2 /lib/puppet/interface/documentation.rb
parent89d447bf425c98407e139eb2a9737906fd45e369 (diff)
downloadpuppet-13e473ed3c2dc53772e75bcb9822b725cf9f8a79.tar.gz
puppet-13e473ed3c2dc53772e75bcb9822b725cf9f8a79.tar.xz
puppet-13e473ed3c2dc53772e75bcb9822b725cf9f8a79.zip
Maint: Add ellipsis to generated short_descriptions.
Auto-generated short descriptions cut off at five lines with no indication that they are truncated. This commit adds ellipsis in brackets to indicate incompleteness.
Diffstat (limited to 'lib/puppet/interface/documentation.rb')
-rw-r--r--lib/puppet/interface/documentation.rb2
1 files changed, 1 insertions, 1 deletions
diff --git a/lib/puppet/interface/documentation.rb b/lib/puppet/interface/documentation.rb
index 48e9a8b1a..aedcc1c24 100644
--- a/lib/puppet/interface/documentation.rb
+++ b/lib/puppet/interface/documentation.rb
@@ -78,7 +78,7 @@ class Puppet::Interface
return nil if @description.nil?
lines = @description.split("\n")
grab = [5, lines.index('') || 5].min
- @short_description = lines[0, grab].join("\n")
+ @short_description = lines[0, grab].join("\n") + ' [...]'
end
@short_description
end