Fix documentation about StorageObject::download()

Author: chapa

doc/services/object-store/v1/objects.rst

@@ -32,6 +32,9 @@ Download an object
 As you will notice, a Stream_ object is returned by this call. For more information about dealing with streams, please
 consult `Guzzle's docs`_.
 
+By default, the whole body of the object is fetched before the function returns, set the ``'guzzle'`` key of parameter
+``$data`` to ``['stream' => true]`` to get the stream before the end of download.
+
 .. _Stream: https://github.com/guzzle/streams/blob/master/src/Stream.php
 .. _Guzzle's docs: https://guzzle.readthedocs.org/en/5.3/streams.html
 

src/ObjectStore/v1/Models/StorageObject.php

@@ -133,8 +133,9 @@ public function retrieve()
     /**
      * This call will perform a `GET` HTTP request for the given object and return back its content in the form of a
      * Guzzle Stream object. Downloading an object will transfer all of the content for an object, and is therefore
-     * distinct from fetching its metadata (a `HEAD` request). The body of an object is not fetched by default to
-     * improve performance when handling large objects.
+     * distinct from fetching its metadata (a `HEAD` request). The whole body of the object is fetched before the
+     * function returns, set the `'guzzle'` key of {@param $data} to `['stream' => true]` to get the stream before the
+     * end of download.
      *
      * @param array $data {@see \OpenStack\ObjectStore\v1\Api::getObject}
      */