Update p5.Image references #6867
Conversation
| * <a href="#/p5.Image">p5.Image</a> object. Colors are stored as numbers | ||
| * representing red, green, blue, and alpha (RGBA) values. `img.pixels` is a | ||
| * one-dimensional array for performance reasons. | ||
| * An array containing the color of each pixel in the image. |
There was a problem hiding this comment.
Hey @nickmcintyre, could you share your thoughts on replacing p5.Image to 'image' in some of the one-line descriptions while keeping p5.Image in others?
There was a problem hiding this comment.
@Qianqianye my thoughts are "oops!" I suggest we use "image" in the one-line description and refer/link to p5.Image objects when it's helpful to clarify types in the long description.
There was a problem hiding this comment.
Thanks @nickmcintyre.
I'd like to get @limzykenneth and @davepagurek's input on this. Since we are considering the possibility of surfacing the instance method references to the main reference page, would it be more or less confusing to include p5.Image in the references?
There was a problem hiding this comment.
For cases where it is referencing things like type of value passed as arguments, I think it is probably better to use p5.Image to avoid ambiguity (eg. There is an Image constructor that creates HTMLImageElement and a selected <image> element for example). If the use is just descriptive or self-describing, such as in this case, I think it should be fine.
Preparing references in
src/image/p5.Image.jsfor the new website.PR Checklist
npm run lintpasses@Qianqianye @davepagurek @limzykenneth