Docs: clarify description of withMetadata

Default and non-default behaviour was mixed in the same paragraph, leading to confusion about when an ICC profile might be expected.
lovell · May 13, 2020 · bbff1c2 · bbff1c2
1 parent b534f99
commit bbff1c2
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/docs/api-output.md b/docs/api-output.md
@@ -91,9 +91,11 @@ Returns **[Promise][5]&lt;[Buffer][8]>** when no callback is provided
 ## withMetadata
 
 Include all metadata (EXIF, XMP, IPTC) from the input image in the output image.
-The default behaviour, when `withMetadata` is not used, is to strip all metadata and convert to the device-independent sRGB colour space.
 This will also convert to and add a web-friendly sRGB ICC profile.
 
+The default behaviour, when `withMetadata` is not used, is to convert to the device-independent
+sRGB colour space and strip all metadata, including the removal of any ICC profile.
+
 ### Parameters
 
 -   `options` **[Object][6]?** 

diff --git a/lib/output.js b/lib/output.js
@@ -118,9 +118,11 @@ function toBuffer (options, callback) {
 
 /**
  * Include all metadata (EXIF, XMP, IPTC) from the input image in the output image.
- * The default behaviour, when `withMetadata` is not used, is to strip all metadata and convert to the device-independent sRGB colour space.
  * This will also convert to and add a web-friendly sRGB ICC profile.
  *
+ * The default behaviour, when `withMetadata` is not used, is to convert to the device-independent
+ * sRGB colour space and strip all metadata, including the removal of any ICC profile.
+ *
  * @example
  * sharp('input.jpg')
  *   .withMetadata()