1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

* lib/prettyprint.rb: Improve documentation. Patch by Ysiad

Browse Source 
Ferreiras.  [#4834]


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@32139 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
drbrain 2011-06-16 22:38:48 +00:00
parent 8bfb41ba7e
commit 463df2ceb9
2 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
Fri Jun 17 07:38:31 2011 Eric Hodel <drbrain@segment7.net>
* lib/prettyprint.rb: Improve documentation. Patch by Ysiad
Ferreiras. [#4834]
Fri Jun 17 07:23:03 2011 Eric Hodel <drbrain@segment7.net> Fri Jun 17 07:23:03 2011 Eric Hodel <drbrain@segment7.net>
* array.c (rb_ary_drop): Improve documentation. Patch by Caley Woods. * array.c (rb_ary_drop): Improve documentation. Patch by Caley Woods.

13
lib/prettyprint.rb
View File

@ -93,6 +93,7 @@ class PrettyPrint
attr_reader :output, :maxwidth, :newline, :genspace attr_reader :output, :maxwidth, :newline, :genspace
attr_reader :indent, :group_queue attr_reader :indent, :group_queue
# Returns the group most recently added to the stack.
def current_group def current_group
@group_stack.last @group_stack.last
end end
@ -119,6 +120,7 @@ class PrettyPrint
current_group.first? current_group.first?
end end
# Breaks the buffer into lines that are shorter than #maxwidth
def break_outmost_groups def break_outmost_groups
while @maxwidth < @output_width + @buffer_width while @maxwidth < @output_width + @buffer_width
return unless group = @group_queue.deq return unless group = @group_queue.deq
@ -155,11 +157,20 @@ class PrettyPrint
end end
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) def fill_breakable(sep=' ', width=sep.length)
group { breakable sep, width } group { breakable sep, width }
end 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. # text +sep+ is inserted if a line is not broken at the point.
# #
# If +sep+ is not specified, " " is used. # If +sep+ is not specified, " " is used.