added documentation to _getBrightness() and _getGreen() function #7908
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ksen0
reviewed
Jun 13, 2025
There was a problem hiding this comment.
A couple of minor typos @FerrinThreatt - otherwise looking good!
Adding documentation steward @perminder-17 - these are some new docs on the private functions, but please add any feedback, or feel free merge when it seems ready to you!
| /** | ||
| * This function extracts the green value from a color object, returns green | ||
| * value in the range of 0 to 255 by default. When colorMode() is set to an | ||
| * RBG value, the green value within the givin range is returned |
| /** | ||
| * Brightness obtains the HSB brightness value from either a p5.Color object, | ||
| * an array of color components, or a CSS color string.Depending on value, | ||
| * when colorMode() is set a HSB value, this function will returns the |
There was a problem hiding this comment.
Minor - typo: "will return" (sing.)
perminder-17
requested changes
Jun 13, 2025
| @@ -546,6 +546,11 @@ class Color { | |||
| } | |||
| } | |||
|
|
|||
| /** | |||
| * This function extracts the green value from a color object, returns green | |||
| * value in the range of 0 to 255 by default. When colorMode() is set to an | |||
There was a problem hiding this comment.
Suggested change
| * value in the range of 0 to 255 by default. When colorMode() is set to an | |
| * value in the range of 0 to 255 by default. When `colorMode()` is set to an |
| /** | ||
| * This function extracts the green value from a color object, returns green | ||
| * value in the range of 0 to 255 by default. When colorMode() is set to an | ||
| * RBG value, the green value within the givin range is returned |
There was a problem hiding this comment.
Suggested change
| * RBG value, the green value within the givin range is returned | |
| * RBG value, the green value within the givin range is returned. |
| @@ -625,6 +630,13 @@ class Color { | |||
| return map(to(this._color, 'hsl').coords[1], colorjsMax[0], colorjsMax[1], max[0], max[1]); | |||
| } | |||
| } | |||
| /** | |||
| * Brightness obtains the HSB brightness value from either a p5.Color object, | |||
| * an array of color components, or a CSS color string.Depending on value, | |||
There was a problem hiding this comment.
Suggested change
| * an array of color components, or a CSS color string.Depending on value, | |
| * an array of color components, or a CSS color string. Depending on value, |
| /** | ||
| * Brightness obtains the HSB brightness value from either a p5.Color object, | ||
| * an array of color components, or a CSS color string.Depending on value, | ||
| * when colorMode() is set a HSB value, this function will returns the |
There was a problem hiding this comment.
Suggested change
| * when colorMode() is set a HSB value, this function will returns the | |
| * when `colorMode()` is set to HSB, this function will returns the |
| @@ -546,6 +546,11 @@ class Color { | |||
| } | |||
| } | |||
|
|
|||
| /** | |||
| * This function extracts the green value from a color object, returns green | |||
There was a problem hiding this comment.
We should rephrase it to something like : "from a color object and returns it in the range 0–255 by default."
| * Brightness obtains the HSB brightness value from either a p5.Color object, | ||
| * an array of color components, or a CSS color string.Depending on value, | ||
| * when colorMode() is set a HSB value, this function will returns the | ||
| * brightness value in the range. By default, this function will return |
There was a problem hiding this comment.
Suggested change
| * brightness value in the range. By default, this function will return | |
| * brightness value within the current range. By default, this function will return |
| * an array of color components, or a CSS color string.Depending on value, | ||
| * when colorMode() is set a HSB value, this function will returns the | ||
| * brightness value in the range. By default, this function will return | ||
| * the HSB brightness within the range 0 - 100. |
There was a problem hiding this comment.
Suggested change
| * the HSB brightness within the range 0 - 100. | |
| * the HSB brightness within the range 0–100. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
addresses #6971
Changes:
added documentation to _getBrightness() and _getGreen() functions
PR Checklist
npm run lintpasses