Here is a collection of issues that I have found so far with the data-type pages.
Most of these are relatively minor, but they stack up as a whole pretty fast.
In General
- These pages could really benefit from having code samples. I set them up to support code samples before my internship ended, but they haven’t received any so far. Any code samples that exist presently could potentially be used, if they happen to refer to any of these data-types.
Axes
- The constructor for this datatype should have links to the
Axis
enum andNormalId
enum, as well as a code sample showing how arguments are passed to this function.
BrickColor
-
BrickColor.Number
should be anint
. - The first constructor,
BrickColor.new(number val)
should use anint
instead of anumber
. - The
BrickColor.palette
constructor should use anint
instead of a number. It might also be worth noting that thepaletteValue
is limited to values in the range [0 - 127] - The
BrickColor.random
constructor should note that it chooses a random color from the palette supplied byBrickColor.palette
Color3
- This page doesn’t have a main description, or indication of where its used.
- The argument types for
Color3.fromRGB
should beint
rather thannumber
.
ColorSequence
- There is no main description for this page, or indication of where its used.
- For the sake of consistency, the types defined as
table
should be defined asarray
instead. - There isn’t anything that directly links the data-type with the
ColorSequenceKeypoint
type’s page.
ColorSequenceKeypoint
- This page doesn’t have a main description, thus it isn’t apparent how you would use it with the ColorSequence type.
DockWidgetPluginGuiInfo
- The type of the first argument in the constructor should be set to
InitialDockState
, rather thanEnum
- The
InitialDockState
property is missing. This property’s type should be set toInitialDockState
, and it should reiterate information from the InitialDockState page.
Enum
- This page has a broken link to the Enum Index page.
Faces
- This page doesn’t have a main description, or indication of where its used.
- The types for the properties on this page should be
bool
, notnumber
. - The constructor should link to the
NormalId
enum page, and include a sample for how to use the constructor.
Instance
- This page should have a main description so that it’s more apparent that its describing the constructor for Instances, and not the Instance class itself. It’s an awkward exception, but one that exists nonetheless.
NumberRange
- This page doesn’t have a main description, or indication of where its used.
NumberSequence
- There is no main description for this page, or indication of where its used.
- For the sake of consistency, the types defined as
table
should be defined asarray
instead. - There isn’t anything that directly links the data-type with the
NumberSequenceKeypoint
type’s page.
NumberSequenceKeypoint
- This page doesn’t have a main description, thus it isn’t apparent how you would use it with the NumberSequence type.
PathWaypoint
- This page doesn’t have a main description, thus its ties to the
Path
class aren’t apparent. -
Enum
should bePathWaypointAction
in the 2nd argument of the constructor and thePathWaypoint.Action
property.
PhysicalProperties
- This page doesn’t have a main description, or indication of where its used.
- The first constructor’s argument type should be set to
Material
rather thanEnum
Ray
- The argument names in the constructor should use camel case?
Rect
- This page doesn’t have a main description, or indication of where its used.
Region3
- This page doesn’t have a main description, or indication of where its used.
- The
Region3:ExpandToGrid(number resolution)
function is missing.
It should return aRegion3
that is aligned with the supplied resolution.
TweenInfo
- This page doesn’t have a main description, or indication of where its used.
-
Enum
should beEasingStyle
inTweenInfo.EasingStyle
and the constructor’s easingStyle. -
Enum
should beEasingDirection
inTweenInfo.EasingDirection
and the constructor’s easingDirection. -
number
should beint
inTweenInfo.RepeatCount
and the constructor’s repeatCount.
UDim
- This page doesn’t have a main description, or indication of where its used.
- The argument names in the constructor should use camel case.
UDim2
- This page doesn’t have a main description, or indication of where its used.
- The constructors on this page do not have any descriptions.
- The math operations on this page seem to be missing their math symbols.
The top one should sayUDim2 + UDim2
and the bottom one should sayUDim2 - UDim2
Vector2
- This page doesn’t have a main description, or indication of where its used.
- The arguments in the constructor are optional, and should default to 0.
Vector3
- This page doesn’t have a main description, or indication of where its used.
- The argument type for
Vector3.FromNormalId
should beNormalId
, notEnum
. - The argument type for
Vector3.FromAxis
should beAxis
, notEnum
.