Improve documetation clarity of material methods #5310
Merged
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.
Minor changes to the wording used in the following material methods, with the goal of improving clarity.
normalMaterial()
1) Reword
Current:
Change:
ambientMaterial()
1) Reword
Current:
Change:
2) Add variant to improve clarity
Use same parameter descriptions as color() reference.
Current:
Change:
3) Improve clarity
Current:
Change:
4) Improve examples
Changes:
example 1:
ambientLight
color so that output matches expectations. I.e. isolate color effect to justambientMaterial
.example 2:
emissiveMaterial()
1) Reword
Current:
Change:
2) Add link that appears in other materials
3) Add variant to improve clarity (and rename
a
param toalpha
)Use same parameter descriptions as color() reference.
Current:
Change:
4) Improve clarity
Current:
Change:
specularMaterial()
1) Reword
Current:
Change:
2) Improve clarity
Current:
Change:
3) Add an example
Change:
Separate PR over here.
shininess()
1) Reword
Current:
Change:
Screenshots of the change
normalMaterial
ambientMaterial
emissiveMaterial
specularMaterial
shininess