Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#6006 issue: Update p5.Color.js #6047

Merged
merged 4 commits into from
Mar 5, 2023
Merged

#6006 issue: Update p5.Color.js #6047

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9905319
#6006 issue: Update p5.Color.js
sawaisinghh Mar 5, 2023
4fe3c32
#6006 issue: update p5.Color.js
sawaisinghh Mar 5, 2023
2c56652
Remove trailing spaces
davepagurek Mar 5, 2023
e270919
Remove more trailing spaces
davepagurek Mar 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/color/p5.Color.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,17 @@ import color_conversion from './color_conversion';
* We also cache normalized, floating-point components of the color in various
* representations as they are calculated. This is done to prevent repeating a
* conversion that has already been performed.
*
* <a href="#/p5/color">color()</a> is the recommended way to create an instance
* of this class. But, if we use constructor then, it is required to use parameters.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be slightly clearer if, instead of "But, if we use constructor then, it is required to use parameters," we instead something like, "However, one can also create a color instace from the constructor using the parameters below."

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, good suggestion

*
* @class p5.Color
* @constructor
* @param {p5} [pInst] pointer to p5 instance.
*
* @param {p5.color|Number[]|String} vals an array or object containing the color
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like the _parseInputs function in the constructor doesn't handle a p5.Color, so I think the type here can just be Number[]|String. We can then also take out the "or object" part from the description.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I will correct it.

* values for red, green, blue and alpha
* channel or CSS color.
*/
p5.Color = function(pInst, vals) {
// Record color mode and maxes at time of construction.
Expand Down