docs(functions): Clarify docs for 'slots' argument to textureCompress

donmccurdy · Oct 23, 2023 · e4f09f6 · e4f09f6
1 parent 22d81cc
commit e4f09f6
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/packages/functions/src/texture-compress.ts b/packages/functions/src/texture-compress.ts
@@ -37,9 +37,16 @@ export interface TextureCompressOptions {
 	resizeFilter?: TextureResizeFilter;
 	/** Pattern identifying textures to compress, matched to name or URI. */
 	pattern?: RegExp | null;
-	/** Pattern matching the format(s) to be compressed or converted. */
+	/**
+	 * Pattern matching the format(s) to be compressed or converted. Some examples
+	 * of formats include "jpeg" and "png".
+	 */
 	formats?: RegExp | null;
-	/** Pattern matching the material texture slot(s) to be compressed or converted. */
+	/**
+	 * Pattern matching the material texture slot(s) to be compressed or converted.
+	 * Some examples of slot names include "baseColorTexture", "occlusionTexture",
+	 * "metallicRoughnessTexture", and "normalTexture".
+	 */
 	slots?: RegExp | null;
 
 	/** Quality, 1-100. Default: auto. */