diff --git a/docs/api-resize.md b/docs/api-resize.md index 35f907d6..a9a76323 100644 --- a/docs/api-resize.md +++ b/docs/api-resize.md @@ -163,11 +163,11 @@ Extract a region of the image. ### Parameters -- `options` **[Object][9]** +- `options` **[Object][9]** describes the region to extract using integral pixel values - `options.left` **[Number][8]** zero-indexed offset from left edge - `options.top` **[Number][8]** zero-indexed offset from top edge - - `options.width` **[Number][8]** dimension of extracted image - - `options.height` **[Number][8]** dimension of extracted image + - `options.width` **[Number][8]** width of region to extract + - `options.height` **[Number][8]** height of region to extract ### Examples diff --git a/lib/resize.js b/lib/resize.js index 1f282493..5a293c34 100644 --- a/lib/resize.js +++ b/lib/resize.js @@ -334,11 +334,11 @@ function extend (extend) { * // Extract a region, resize, then extract from the resized image * }); * - * @param {Object} options + * @param {Object} options - describes the region to extract using integral pixel values * @param {Number} options.left - zero-indexed offset from left edge * @param {Number} options.top - zero-indexed offset from top edge - * @param {Number} options.width - dimension of extracted image - * @param {Number} options.height - dimension of extracted image + * @param {Number} options.width - width of region to extract + * @param {Number} options.height - height of region to extract * @returns {Sharp} * @throws {Error} Invalid parameters */