Feb 18, 2016 · Dec 22, 2015 · Dec 22, 2015 · Dec 22, 2015 · Dec 22, 2015 · Dec 22, 2015
diff --git a/lib/matplotlib/image.py b/lib/matplotlib/image.py

 def composite_images(images, renderer, magnification=1.0):
    """
    Composite a number of RGBA images into one.
    Composite a number of RGBA images into one.  The images are
    composited in the order in which they appear in the `images` list.

    Parameters
    ----------
    images : list of objects with `make_image` method
    images : list of Images
        Each must have a `make_image` method.  For each image,
        `can_composite` should return `True`, though this is not
        enforced by this function.  Each image must have a purely
        affine transformation with no shear.

    renderer : RendererBase instance

    magnification : float
        The additional magnification to apply for the renderer in use.

    Returns
    -------
    tuple : image, offset_x, offset_y
        Returns the tuple:

        - image: A numpy array of the same type as the input images.

        - offset_x, offset_y: The offset of the image (left, bottom)
          in the output figure.
    """
    if len(images) == 0:
        return np.empty((0, 0, 4), dtype=np.uint8), 0, 0
Original file line number	Diff line number	Diff line change
Expand Up		@@ -61,16 +61,31 @@

		def composite_images(images, renderer, magnification=1.0):
		"""
		Composite a number of RGBA images into one.
		Composite a number of RGBA images into one. The images are
		composited in the order in which they appear in the `images` list.

		Parameters
		----------
		images : list of objects with `make_image` method
		images : list of Images
		Each must have a `make_image` method. For each image,
		`can_composite` should return `True`, though this is not
		enforced by this function. Each image must have a purely
		affine transformation with no shear.

		renderer : RendererBase instance

		magnification : float
		The additional magnification to apply for the renderer in use.
Copy link Member WeatherGodJan 6, 2016 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. This docstring doesn't describe what it returns. Copy link Member WeatherGodJan 6, 2016 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Might also want to make it clear whose responsibility it will be to handle zorder. Copy link MemberAuthor mdboomJan 7, 2016 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Good points. Done.

		Returns
		-------
		tuple : image, offset_x, offset_y
		Returns the tuple:

		- image: A numpy array of the same type as the input images.

		- offset_x, offset_y: The offset of the image (left, bottom)
		in the output figure.
		"""
		if len(images) == 0:
		return np.empty((0, 0, 4), dtype=np.uint8), 0, 0
Expand Down