processing-website icon indicating copy to clipboard operation
processing-website copied to clipboard

Use of word "increment" in docs for lerpColor()

Open soegaard opened this issue 4 years ago • 2 comments

Issue description

The docs reads: "Calculates a color between two colors at a specific increment. "

The word "increment" normally means "an amount to be added", but in this context amount is a fraction between 0.0 and 1.0.

URL(s) of affected page(s)

https://processing.org/reference/lerpColor_.html

Proposed fix

Choose a better word.

soegaard avatar Jun 06 '21 17:06 soegaard

I am interested in working on this issue. @SableRaf Can I be assigned?

Arya-Gupta avatar Jan 25 '23 10:01 Arya-Gupta

@soegaard Thanks for bringing this up. I think you're right that "increment" is not the most accurate word to use in this context. I believe we could just drop the word and rewrite the first paragraph as follows:

Calculates a new color that is a blend of two other colors. The amt parameter controls the amount of each color to use where an amount of 0.0 will produce the first color, 1.0 will return the second color, and 0.5 is halfway in between. Values between 0.0 and 1.0 will interpolate between the two colors in that proportion.

@Arya-Gupta Great to hear that you're interested in working on this issue. I will go ahead and assign the task to you. Please keep in mind that edits to the documentation for Processing API function are done in the JavaDoc on the processing4 repo. In this particular case, you can find the lerpColor() description here.

I have updated the readme to make the steps to edit the reference clearer hopefully. Let me know if you have any questions or need assistance. Thanks again for your contributions!

SableRaf avatar Jan 26 '23 09:01 SableRaf