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.

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

Docs: Improve Color page. #25577

Merged
merged 1 commit into from
Feb 27, 2023
Merged

Docs: Improve Color page. #25577

merged 1 commit into from
Feb 27, 2023

Conversation

Mugen87
Copy link
Collaborator

@Mugen87 Mugen87 commented Feb 27, 2023

Fixed #25571.

Description

Adds getRGB() to the Color docs.

@Mugen87 Mugen87 added this to the r151 milestone Feb 27, 2023
@Mugen87 Mugen87 merged commit 355ce7c into mrdoob:dev Feb 27, 2023
@Mugen87
Copy link
Collaborator Author

Mugen87 commented Feb 27, 2023

@donmccurdy When the colorSpace parameter was added in #23392, only the signature of the Color methods were updated in the docs. The parameter itself has no description. For example getHSL() is currently documented like so:

<h3>[method:Object getHSL]( [param:Object target], [param:string colorSpace] = LinearSRGBColorSpace )</h3>
<p>
[page:Object target] — the result will be copied into this Object. Adds h, s and l keys to the object (if not already present).<br /><br />

But it should be something like:

<h3>[method:Object getHSL]( [param:Object target], [param:string colorSpace] = LinearSRGBColorSpace )</h3> 
 <p> 
 	[page:Object target] — the result will be copied into this Object. Adds h, s and l keys to the object (if not already present).<br />
 	[page:String colorSpace] — ???. Default is `LinearSRGBColorSpace`.<br /><br />

How should we document colorSpace?

@Methuselah96 Methuselah96 mentioned this pull request Apr 25, 2023
37 tasks
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing Docs: Color.getRGB
1 participant