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: style numbers (en). #26147

Merged
merged 3 commits into from
Jun 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/api/en/animation/AnimationAction.html
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ <h3>[property:Boolean clampWhenFinished]</h3>
automatically be switched to false when the last loop of the action has
finished, so that this action has no further impact.<br /><br />

Default is false.<br /><br />
Default is `false`.<br /><br />

Note: `clampWhenFinished` has no impact if the action is interrupted (it
has only an effect if its last loop has really finished).
Expand Down Expand Up @@ -140,7 +140,7 @@ <h3>[property:Number timeScale]</h3>
<h3>[property:Number weight]</h3>
<p>
The degree of influence of this action (in the interval `[0, 1]`). Values
between `0` (no impact) and 1 (full impact) can be used to blend between
between `0` (no impact) and `1` (full impact) can be used to blend between
several actions. Default is `1`. <br /><br />
Properties/methods concerning `weight` are:
[page:.crossFadeFrom crossFadeFrom],
Expand Down Expand Up @@ -179,7 +179,7 @@ <h3>
of the time scales) will be applied.<br /><br />

Note: Like with `fadeIn`/`fadeOut`, the fading starts/ends with a weight
of 1.
of `1`.
</p>

<h3>
Expand All @@ -193,7 +193,7 @@ <h3>
of the time scales) will be applied.<br /><br />

Note: Like with `fadeIn`/`fadeOut`, the fading starts/ends with a weight
of 1.
of `1`.
</p>

<h3>[method:this fadeIn]( [param:Number durationInSeconds] )</h3>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/en/animation/tracks/ColorKeyframeTrack.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ <h3>
[page:String name] - (required) identifier for the KeyframeTrack.<br />
[page:Array times] - (required) array of keyframe times.<br />
[page:Array values] - values for the keyframes at the times specified, a
flat array of color components between 0 and 1.<br />
flat array of color components between `0` and `1`.<br />
[page:Constant interpolation] - the type of interpolation to use. See
[page:Animation Animation Constants] for possible values. Default is
[page:Animation InterpolateLinear].
Expand Down
2 changes: 1 addition & 1 deletion docs/api/en/cameras/PerspectiveCamera.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ <h3>[property:Float far]</h3>

<h3>[property:Float filmGauge]</h3>
<p>
Film size used for the larger axis. Default is 35 (millimeters). This
Film size used for the larger axis. Default is `35` (millimeters). This
parameter does not influence the projection matrix unless .filmOffset is
set to a nonzero value.
</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/en/constants/Materials.html
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ <h2>Stencil Operations</h2>
<p>
Which stencil operation the material will perform on the stencil buffer
pixel if the provided stencil function passes.<br />
[page:Materials ZeroStencilOp] will set the stencil value to 0.<br />
[page:Materials ZeroStencilOp] will set the stencil value to `0`.<br />
[page:Materials KeepStencilOp] will not change the current stencil
value.<br />
[page:Materials ReplaceStencilOp] will replace the stencil value with the
Expand Down
2 changes: 1 addition & 1 deletion docs/api/en/core/BufferGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ <h3>[method:this lookAt] ( [param:Vector3 vector] )</h3>

<h3>[method:undefined normalizeNormals]()</h3>
<p>
Every normal vector in a geometry will have a magnitude of 1. This will
Every normal vector in a geometry will have a magnitude of `1`. This will
correct lighting on the geometry surfaces.
</p>

Expand Down
4 changes: 2 additions & 2 deletions docs/api/en/core/Raycaster.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ <h3>[name]( [param:Vector3 origin], [param:Vector3 direction], [param:Float near
[page:Vector3 direction] — The direction vector that gives direction to
the ray. Should be normalized.<br />
[page:Float near] — All results returned are further away than near. Near
can't be negative. Default value is 0.<br />
can't be negative. Default value is `0`.<br />
[page:Float far] — All results returned are closer than far. Far can't be
lower than near. Default value is Infinity.
</p>
Expand Down Expand Up @@ -155,7 +155,7 @@ <h3>[method:undefined set]( [param:Vector3 origin], [param:Vector3 direction])</
<h3>[method:undefined setFromCamera]( [param:Vector2 coords], [param:Camera camera] )</h3>
<p>
[page:Vector2 coords] — 2D coordinates of the mouse, in normalized device
coordinates (NDC)---X and Y components should be between -1 and 1.<br />
coordinates (NDC)---X and Y components should be between `-1` and `1`.<br />
[page:Camera camera] — camera from which the ray should originate
</p>
<p>Updates the ray with a new origin and direction.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/en/extras/core/Curve.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ <h3>[property:Integer arcLengthDivisions]</h3>
cumulative segment lengths of a curve via [page:.getLengths]. To ensure
precision when using methods like [page:.getSpacedPoints], it is
recommended to increase [page:.arcLengthDivisions] if the curve is very
large. Default is 200.
large. Default is `200`.
</p>

<h2>Methods</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/en/extras/core/Path.html
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ <h3>[method:this absellipse]( [param:Float x], [param:Float y], [param:Float xRa
endAngle -- The end angle in radians.<br />
clockwise -- Sweep the ellipse clockwise. Defaults to false.<br />
rotation -- The rotation angle of the ellipse in radians, counterclockwise
from the positive X axis. Optional, defaults to 0.<br /><br />
from the positive X axis. Optional, defaults to `0`.<br /><br />

Adds an absolutely positioned [page:EllipseCurve EllipseCurve] to the
path.
Expand Down
12 changes: 6 additions & 6 deletions docs/api/en/geometries/BoxGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,22 +58,22 @@ <h3>
</h3>
<p>
width — Width; that is, the length of the edges parallel to the X axis.
Optional; defaults to 1.
Optional; defaults to `1`.
<br />
height — Height; that is, the length of the edges parallel to the Y axis.
Optional; defaults to 1.
Optional; defaults to `1`.
<br />
depth — Depth; that is, the length of the edges parallel to the Z axis.
Optional; defaults to 1.
Optional; defaults to `1`.
<br />
widthSegments — Number of segmented rectangular faces along the width of
the sides. Optional; defaults to 1.
the sides. Optional; defaults to `1`.
<br />
heightSegments — Number of segmented rectangular faces along the height of
the sides. Optional; defaults to 1.
the sides. Optional; defaults to `1`.
<br />
depthSegments — Number of segmented rectangular faces along the depth of
the sides. Optional; defaults to 1.
the sides. Optional; defaults to `1`.
<br />
</p>

Expand Down
8 changes: 4 additions & 4 deletions docs/api/en/geometries/CapsuleGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,12 @@ <h3>
[name]([param:Float radius], [param:Float length], [param:Integer capSubdivisions], [param:Integer radialSegments])
</h3>
<p>
radius — Radius of the capsule. Optional; defaults to 1.<br />
length — Length of the middle section. Optional; defaults to 1.<br />
radius — Radius of the capsule. Optional; defaults to `1`.<br />
length — Length of the middle section. Optional; defaults to `1`.<br />
capSegments — Number of curve segments used to build the caps. Optional;
defaults to 4.<br />
defaults to `4`.<br />
radialSegments — Number of segmented faces around the circumference of the
capsule. Optional; defaults to 8.<br />
capsule. Optional; defaults to `8`.<br />
</p>

<h2>Properties</h2>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/en/geometries/CircleGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,11 @@ <h3>
</h3>
<p>
radius — Radius of the circle, default = 1.<br />
segments — Number of segments (triangles), minimum = 3, default = 32.<br />
thetaStart — Start angle for first segment, default = 0 (three o'clock
segments — Number of segments (triangles), minimum = `3`, default = `32`.<br />
thetaStart — Start angle for first segment, default = `0` (three o'clock
position).<br />
thetaLength — The central angle, often called theta, of the circular
sector. The default is 2*Pi, which makes for a complete circle.
sector. The default is `2`*Pi, which makes for a complete circle.
</p>

<h2>Properties</h2>
Expand Down
10 changes: 5 additions & 5 deletions docs/api/en/geometries/ConeGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,18 +45,18 @@ <h3>
[name]([param:Float radius], [param:Float height], [param:Integer radialSegments], [param:Integer heightSegments], [param:Boolean openEnded], [param:Float thetaStart], [param:Float thetaLength])
</h3>
<p>
radius — Radius of the cone base. Default is 1.<br />
height — Height of the cone. Default is 1.<br />
radius — Radius of the cone base. Default is `1`.<br />
height — Height of the cone. Default is `1`.<br />
radialSegments — Number of segmented faces around the circumference of the
cone. Default is 32<br />
cone. Default is `32`<br />
heightSegments — Number of rows of faces along the height of the cone.
Default is 1.<br />
Default is `1`.<br />
openEnded — A Boolean indicating whether the base of the cone is open or
capped. Default is false, meaning capped.<br />
thetaStart — Start angle for first segment, default = 0 (three o'clock
position).<br />
thetaLength — The central angle, often called theta, of the circular
sector. The default is 2*Pi, which makes for a complete cone.
sector. The default is `2`*Pi, which makes for a complete cone.
</p>

<h2>Properties</h2>
Expand Down
12 changes: 6 additions & 6 deletions docs/api/en/geometries/CylinderGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,19 +49,19 @@ <h3>
[param:Boolean openEnded], [param:Float thetaStart], [param:Float thetaLength])
</h3>
<p>
radiusTop — Radius of the cylinder at the top. Default is 1.<br />
radiusBottom — Radius of the cylinder at the bottom. Default is 1.<br />
height — Height of the cylinder. Default is 1.<br />
radiusTop — Radius of the cylinder at the top. Default is `1`.<br />
radiusBottom — Radius of the cylinder at the bottom. Default is `1`.<br />
height — Height of the cylinder. Default is `1`.<br />
radialSegments — Number of segmented faces around the circumference of the
cylinder. Default is 32<br />
cylinder. Default is `32`<br />
heightSegments — Number of rows of faces along the height of the cylinder.
Default is 1.<br />
Default is `1`.<br />
openEnded — A Boolean indicating whether the ends of the cylinder are open
or capped. Default is false, meaning capped.<br />
thetaStart — Start angle for first segment, default = 0 (three o'clock
position).<br />
thetaLength — The central angle, often called theta, of the circular
sector. The default is 2*Pi, which makes for a complete cylinder.
sector. The default is `2`*Pi, which makes for a complete cylinder.
</p>

<h2>Properties</h2>
Expand Down
4 changes: 2 additions & 2 deletions docs/api/en/geometries/DodecahedronGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ <h2>Constructor</h2>

<h3>[name]([param:Float radius], [param:Integer detail])</h3>
<p>
radius — Radius of the dodecahedron. Default is 1.<br />
detail — Default is 0. Setting this to a value greater than 0 adds
radius — Radius of the dodecahedron. Default is `1`.<br />
detail — Default is `0`. Setting this to a value greater than `0` adds
vertices making it no longer a dodecahedron.
</p>

Expand Down
12 changes: 6 additions & 6 deletions docs/api/en/geometries/ExtrudeGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,29 +72,29 @@ <h3>[name]([param:Array shapes], [param:Object options])</h3>

<ul>
<li>
curveSegments — int. Number of points on the curves. Default is 12.
curveSegments — int. Number of points on the curves. Default is `12`.
</li>
<li>
steps — int. Number of points used for subdividing segments along the
depth of the extruded spline. Default is 1.
depth of the extruded spline. Default is `1`.
</li>
<li>depth — float. Depth to extrude the shape. Default is 1.</li>
<li>depth — float. Depth to extrude the shape. Default is `1`.</li>
<li>
bevelEnabled — bool. Apply beveling to the shape. Default is true.
</li>
<li>
bevelThickness — float. How deep into the original shape the bevel goes.
Default is 0.2.
Default is `0.2`.
</li>
<li>
bevelSize — float. Distance from the shape outline that the bevel
extends. Default is bevelThickness - 0.1.
</li>
<li>
bevelOffset — float. Distance from the shape outline that the bevel
starts. Default is 0.
starts. Default is `0`.
</li>
<li>bevelSegments — int. Number of bevel layers. Default is 3.</li>
<li>bevelSegments — int. Number of bevel layers. Default is `3`.</li>
<li>
extrudePath — THREE.Curve. A 3D spline path along which the shape should
be extruded. Bevels not supported for path extrusion.
Expand Down
4 changes: 2 additions & 2 deletions docs/api/en/geometries/IcosahedronGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ <h2>Constructor</h2>

<h3>[name]([param:Float radius], [param:Integer detail])</h3>
<p>
radius — Default is 1. <br />
detail — Default is 0. Setting this to a value greater than 0 adds more
radius — Default is `1`. <br />
detail — Default is `0`. Setting this to a value greater than `0` adds more
vertices making it no longer an icosahedron. When detail is greater than
1, it's effectively a sphere.
</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/en/geometries/LatheGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ <h3>
creates a simple diamond shape.<br />
segments — the number of circumference segments to generate. Default is
12.<br />
phiStart — the starting angle in radians. Default is 0.<br />
phiStart — the starting angle in radians. Default is `0`.<br />
phiLength — the radian (0 to 2PI) range of the lathed section 2PI is a
closed lathe, less than 2PI is a portion. Default is 2PI.
</p>
Expand Down
4 changes: 2 additions & 2 deletions docs/api/en/geometries/OctahedronGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ <h2>Constructor</h2>

<h3>[name]([param:Float radius], [param:Integer detail])</h3>
<p>
radius — Radius of the octahedron. Default is 1.<br />
detail — Default is 0. Setting this to a value greater than zero add
radius — Radius of the octahedron. Default is `1`.<br />
detail — Default is `0`. Setting this to a value greater than zero add
vertices making it no longer an octahedron.
</p>

Expand Down
8 changes: 4 additions & 4 deletions docs/api/en/geometries/PlaneGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ <h3>
widthSegments], [param:Integer heightSegments])
</h3>
<p>
width — Width along the X axis. Default is 1.<br />
height — Height along the Y axis. Default is 1.<br />
widthSegments — Optional. Default is 1. <br />
heightSegments — Optional. Default is 1.
width — Width along the X axis. Default is `1`.<br />
height — Height along the Y axis. Default is `1`.<br />
widthSegments — Optional. Default is `1`. <br />
heightSegments — Optional. Default is `1`.
</p>

<h2>Properties</h2>
Expand Down
10 changes: 5 additions & 5 deletions docs/api/en/geometries/RingGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ <h3>
[param:Integer thetaSegments], [param:Integer phiSegments], [param:Float thetaStart], [param:Float thetaLength])
</h3>
<p>
innerRadius — Default is 0.5. <br />
outerRadius — Default is 1. <br />
innerRadius — Default is `0.5`. <br />
outerRadius — Default is `1`. <br />
thetaSegments — Number of segments. A higher number means the ring will be
more round. Minimum is 3. Default is 32. <br />
phiSegments — Minimum is 1. Default is 1.<br />
thetaStart — Starting angle. Default is 0. <br />
more round. Minimum is `3`. Default is `32`. <br />
phiSegments — Minimum is `1`. Default is `1`.<br />
thetaStart — Starting angle. Default is `0`. <br />
thetaLength — Central angle. Default is Math.PI * 2.
</p>

Expand Down
14 changes: 7 additions & 7 deletions docs/api/en/geometries/SphereGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,15 @@ <h3>
</h3>

<p>
radius — sphere radius. Default is 1.<br />
widthSegments — number of horizontal segments. Minimum value is 3, and the
default is 32.<br />
heightSegments — number of vertical segments. Minimum value is 2, and the
default is 16.<br />
phiStart — specify horizontal starting angle. Default is 0.<br />
radius — sphere radius. Default is `1`.<br />
widthSegments — number of horizontal segments. Minimum value is `3`, and the
default is `32`.<br />
heightSegments — number of vertical segments. Minimum value is `2`, and the
default is `16`.<br />
phiStart — specify horizontal starting angle. Default is `0`.<br />
phiLength — specify horizontal sweep angle size. Default is Math.PI *
2.<br />
thetaStart — specify vertical starting angle. Default is 0.<br />
thetaStart — specify vertical starting angle. Default is `0`.<br />
thetaLength — specify vertical sweep angle size. Default is Math.PI.<br />
</p>

Expand Down
4 changes: 2 additions & 2 deletions docs/api/en/geometries/TetrahedronGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ <h2>Constructor</h2>

<h3>[name]([param:Float radius], [param:Integer detail])</h3>
<p>
radius — Radius of the tetrahedron. Default is 1.<br />
detail — Default is 0. Setting this to a value greater than 0 adds
radius — Radius of the tetrahedron. Default is `1`.<br />
detail — Default is `0`. Setting this to a value greater than `0` adds
vertices making it no longer a tetrahedron.
</p>

Expand Down
8 changes: 4 additions & 4 deletions docs/api/en/geometries/TorusGeometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@ <h3>
</h3>
<p>
radius - Radius of the torus, from the center of the torus to the center
of the tube. Default is 1. <br />
tube — Radius of the tube. Default is 0.4. <br />
radialSegments — Default is 12 <br />
tubularSegments — Default is 48. <br />
of the tube. Default is `1`. <br />
tube — Radius of the tube. Default is `0.4`. <br />
radialSegments — Default is `12` <br />
tubularSegments — Default is `48`. <br />
arc — Central angle. Default is Math.PI * 2.
</p>

Expand Down