Revise saveFrames() reference

nickmcintyre · nickmcintyre · commit b7a6129854cb · 2024-03-15T08:40:20.000-07:00
diff --git a/src/image/image.js b/src/image/image.js
@@ -556,11 +556,11 @@ p5.prototype.encodeAndDownloadGif = function(pImg, filename) {
 };
 
 /**
- * Creates an array of frames from the canvas that can be saved as images.
+ * Captures a sequence of frames from the canvas that can be saved as images.
  *
- * Each frame is stored as an object with its file type, file name, and image
- * data as a string. For example, the first saved frame might
- * have the following object:
+ * `saveFrames()` creates an array of frame objects. Each frame is stored as
+ * an object with its file type, file name, and image data as a string. For
+ * example, the first saved frame might have the following properties:
  *
  * `{ ext: 'png', filenmame: 'frame0', imageData: 'data:image/octet-stream;base64, abc123' }`.
  *

Original file line number	Diff line number	Diff line change
`@@ -556,11 +556,11 @@ p5.prototype.encodeAndDownloadGif = function(pImg, filename) {`
`556`	`556`	`};`
`557`	`557`
`558`	`558`	`/**`
`559`		`- * Creates an array of frames from the canvas that can be saved as images.`
	`559`	`+ * Captures a sequence of frames from the canvas that can be saved as images.`
`560`	`560`	`*`
`561`		`- * Each frame is stored as an object with its file type, file name, and image`
`562`		`- * data as a string. For example, the first saved frame might`
`563`		`- * have the following object:`
	`561`	+ * `saveFrames()` creates an array of frame objects. Each frame is stored as
	`562`	`+ * an object with its file type, file name, and image data as a string. For`
	`563`	`+ * example, the first saved frame might have the following properties:`
`564`	`564`	`*`
`565`	`565`	* `{ ext: 'png', filenmame: 'frame0', imageData: 'data:image/octet-stream;base64, abc123' }`.
`566`	`566`	`*`