Docs: clarify composite operation ordering #4288

lovell · lovell · commit 82dc859a496f · 2024-12-05T12:36:52.000Z
diff --git a/docs/api-composite.md b/docs/api-composite.md
@@ -6,8 +6,8 @@ Composite image(s) over the processed (resized, extracted etc.) image.
 The images to composite must be the same size or smaller than the processed image.
 If both `top` and `left` options are provided, they take precedence over `gravity`.
 
-Any resize, rotate or extract operations in the same processing pipeline
-will always be applied to the input image before composition.
+Other operations in the same processing pipeline (e.g. resize, rotate, flip,
+flop, extract) will always be applied to the input image before composition.
 
 The `blend` option can be one of `clear`, `source`, `over`, `in`, `out`, `atop`,
 `dest`, `dest-over`, `dest-in`, `dest-out`, `dest-atop`,
diff --git a/lib/composite.js b/lib/composite.js
@@ -46,8 +46,8 @@ const blend = {
  * The images to composite must be the same size or smaller than the processed image.
  * If both `top` and `left` options are provided, they take precedence over `gravity`.
  *
- * Any resize, rotate or extract operations in the same processing pipeline
- * will always be applied to the input image before composition.
+ * Other operations in the same processing pipeline (e.g. resize, rotate, flip,
+ * flop, extract) will always be applied to the input image before composition.
  *
  * The `blend` option can be one of `clear`, `source`, `over`, `in`, `out`, `atop`,
  * `dest`, `dest-over`, `dest-in`, `dest-out`, `dest-atop`,

Original file line number	Diff line number	Diff line change
`@@ -46,8 +46,8 @@ const blend = {`
`46`	`46`	`* The images to composite must be the same size or smaller than the processed image.`
`47`	`47`	* If both `top` and `left` options are provided, they take precedence over `gravity`.
`48`	`48`	`*`
`49`		`- * Any resize, rotate or extract operations in the same processing pipeline`
`50`		`- * will always be applied to the input image before composition.`
	`49`	`+ * Other operations in the same processing pipeline (e.g. resize, rotate, flip,`
	`50`	`+ * flop, extract) will always be applied to the input image before composition.`
`51`	`51`	`*`
`52`	`52`	* The `blend` option can be one of `clear`, `source`, `over`, `in`, `out`, `atop`,
`53`	`53`	* `dest`, `dest-over`, `dest-in`, `dest-out`, `dest-atop`,