Merge 0855e4a into da5deb8

lovell · Jan 13, 2018 · 3dd25ad · 3dd25ad
2 parents da5deb8 + 0855e4a
commit 3dd25ad
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/lib/resize.js b/lib/resize.js
@@ -253,6 +253,7 @@ function ignoreAspectRatio () {
  * Do not enlarge the output image if the input image width *or* height are already less than the required dimensions.
  * This is equivalent to GraphicsMagick's `>` geometry option:
  * "*change the dimensions of the image only if its width or height exceeds the geometry specification*".
+ * Use with `max()` to preserve the image's aspect ratio.
  *
  * The default behaviour *before* function call is `false`, meaning the image will be enlarged.
  *