Docs: Object3D&SpotLight&TorusGeometry #22906
Merged
Conversation
This file contains 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
About Object3D: The value type of the children property is Array, but the documents of zh, en, ko all define it as Object3D. About SpotLight: In the description of the target attribute, the SpotLight is translated into a DirectionalLight, this should be an unintentional mistake. (the error only occurs in Chinese documents).
Correct the definition of `radius` and 'radiusSegments' in '构造器'.
jynxio
changed the title
Mugen87
reviewed
Nov 29, 2021
| @@ -35,7 +35,7 @@ <h3>[property:AnimationClip animations]</h3> | |||
| <h3>[property:Boolean castShadow]</h3> | |||
| <p>Whether the object gets rendered into shadow map. Default is *false*.</p> | |||
|
|
|||
| <h3>[property:Object3D children]</h3> | |||
| <h3>[property:Array children]</h3> | |||
There was a problem hiding this comment.
At some point, we should document such properties or return types as: [property:Array<Object3D> children].
Unfortunately, the docs do no support such a markup yet. Maybe we can add something like this in a future PR?
|
Thanks! |
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.
Fixed #22827.
Description
1.Object3D
Change: The value type of
childrenproperty is changed fromObject3DtoArray.Reason: The value type of the children property is
Array, it is described asObject3Din the document.Target: zh, en, ko
2.SpotLight
Change: In the description of the
targetproperty, the term is changed from平行光to聚光灯.Reason:
平行光stands forDirectionalLight,聚光灯stands forSpotLight. Obviously,聚光灯shoudle be used here.Target: zh
3.TorusGeometry
Change: In the parameters of
构造器, the Chinese annotations ofradiusandradialSegmentsare changed.Reason: #22827 (you can see the reason and change in the second comment)
Target: zh