From 463df2ceb97bd79e7e7105f30839c12f4327a177 Mon Sep 17 00:00:00 2001 From: drbrain Date: Thu, 16 Jun 2011 22:38:48 +0000 Subject: * lib/prettyprint.rb: Improve documentation. Patch by Ysiad Ferreiras. [#4834] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@32139 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- lib/prettyprint.rb | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'lib/prettyprint.rb') diff --git a/lib/prettyprint.rb b/lib/prettyprint.rb index 2c1fff3258..8b33bdf85f 100644 --- a/lib/prettyprint.rb +++ b/lib/prettyprint.rb @@ -93,6 +93,7 @@ class PrettyPrint attr_reader :output, :maxwidth, :newline, :genspace attr_reader :indent, :group_queue + # Returns the group most recently added to the stack. def current_group @group_stack.last end @@ -119,6 +120,7 @@ class PrettyPrint current_group.first? end + # Breaks the buffer into lines that are shorter than #maxwidth def break_outmost_groups while @maxwidth < @output_width + @buffer_width return unless group = @group_queue.deq @@ -155,11 +157,20 @@ class PrettyPrint end end + # This is similar to #breakable, but is less-likely to insert a newline. + # + # The text sep+ is inserted if a line is not broken at this point. + # + # If +sep+ is not specified, " " is used. + # + # If +width+ is not specified, +sep.length+ is used. You will have to + # specify this when +sep+ is a multibyte character, for example. + # def fill_breakable(sep=' ', width=sep.length) group { breakable sep, width } end - # This tells "you can break a line here if necessary", and a +width+\-column + # This says "you can break a line here if necessary", and a +width+\-column # text +sep+ is inserted if a line is not broken at the point. # # If +sep+ is not specified, " " is used. -- cgit v1.2.3