Skip to content

Commit

Permalink
Merge pull request #1804 from Fonsan/fix_documentation_s3_upload_stream
Browse files Browse the repository at this point in the history
Fixed and improved documentation for Object#upload_stream
  • Loading branch information
awood45 authored Jun 26, 2018
2 parents 410e949 + 4d5a5ab commit 6bd8cf4
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions gems/aws-sdk-s3/lib/aws-sdk-s3/customizations/object.rb
Original file line number Diff line number Diff line change
Expand Up @@ -223,8 +223,16 @@ def public_url(options = {})
# Note that this is known to have issues in JRuby until jruby-9.1.15.0, so avoid using this with older versions of JRuby.
#
# @example Streaming chunks of data
# obj.upload_file do |write_stream|
# 10.times { write_stream << 'hello' }
# obj.upload_stream do |write_stream|
# 10.times { write_stream << 'foo' }
# end
# @example Streaming chunks of data
# obj.upload_stream do |write_stream|
# IO.copy_stream(IO.popen('ls'), write_stream)
# end
# @example Streaming chunks of data
# obj.upload_stream do |write_stream|
# IO.copy_stream(STDIN, write_stream)
# end
#
# @option options [Integer] :thread_count
Expand Down

0 comments on commit 6bd8cf4

Please sign in to comment.