geotiffimage: stop mentioning that readRGB() forces interleaving

geotiffjs · Mar 26, 2024 · 8c74732 · 8c74732
1 parent d6b48ad
commit 8c74732
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -360,8 +360,7 @@ YCbCr, and CIE L*a*b.
 
 geotiff.js provides a method to automatically convert these images to RGB:
 `readRGB()`. This method is very similar to the `readRasters` method with
-distinction that the `interleave` option is now always `true` and the
-`samples` are automatically chosen.
+distinction the `samples` are automatically chosen.
 
 ```javascript
 const rgb = await image.readRGB({

diff --git a/src/geotiffimage.js b/src/geotiffimage.js
@@ -615,8 +615,7 @@ class GeoTIFFImage {
   }
 
   /**
-   * Reads raster data from the image as RGB. The result is always an
-   * interleaved typed array.
+   * Reads raster data from the image as RGB.
    * Colorspaces other than RGB will be transformed to RGB, color maps expanded.
    * When no other method is applicable, the first sample is used to produce a
    * grayscale image.