1
0
Fork 0
mirror of https://github.com/fog/fog.git synced 2022-11-09 13:51:43 -05:00

Fog::Storage::OpenStack::Real#put_object: Document the block parameter

Fog::Storage::Rackspace::Real#put_object: Same
This commit is contained in:
Dmitry Gutov 2013-09-24 03:21:58 +03:00
parent f7427db942
commit baff59ad3e
2 changed files with 11 additions and 1 deletions

View file

@ -5,11 +5,16 @@ module Fog
# Create a new object # Create a new object
# #
# When passed a block, it will make a chunked request, calling
# the block for chunks until it returns an empty string.
# In this case the data parameter is ignored.
#
# ==== Parameters # ==== Parameters
# * container<~String> - Name for container, should be < 256 bytes and must not contain '/' # * container<~String> - Name for container, should be < 256 bytes and must not contain '/'
# * object<~String> - Name for object # * object<~String> - Name for object
# * data<~String|File> - data to upload # * data<~String|File> - data to upload
# * options<~Hash> - config headers for object. Defaults to {}. # * options<~Hash> - config headers for object. Defaults to {}.
# * block<~Proc> - chunker
# #
def put_object(container, object, data, options = {}, &block) def put_object(container, object, data, options = {}, &block)
if block_given? if block_given?

View file

@ -5,11 +5,16 @@ module Fog
# Create a new object # Create a new object
# #
# When passed a block, it will make a chunked request, calling
# the block for chunks until it returns an empty string.
# In this case the data parameter is ignored.
#
# ==== Parameters # ==== Parameters
# * container<~String> - Name for container, should be < 256 bytes and must not contain '/' # * container<~String> - Name for container, should be < 256 bytes and must not contain '/'
# * object<~String> - Name for object # * object<~String> - Name for object
# * data<~String|File> - data to upload # * data<~String|File> - data to upload
# * options<~Hash> - config headers for object. Defaults to {}. # * options<~Hash> - config headers for object. Defaults to #{}.
# * block<~Proc> - chunker
# @raise [Fog::Storage::Rackspace::NotFound] - HTTP 404 # @raise [Fog::Storage::Rackspace::NotFound] - HTTP 404
# @raise [Fog::Storage::Rackspace::BadRequest] - HTTP 400 # @raise [Fog::Storage::Rackspace::BadRequest] - HTTP 400
# @raise [Fog::Storage::Rackspace::InternalServerError] - HTTP 500 # @raise [Fog::Storage::Rackspace::InternalServerError] - HTTP 500