Typos & Minor Edits Mega-thread [Closed]

Looks like “##Note” is being used, but a yellow warning box such as the “Yields” one that is pictured would be more appropriate in this situation.


https://developer.roblox.com/en-us/api-reference/function/Player/IsInGroup

On the top of the Tuple documentation page, there’s a blue area on the top of the page which displays the text "> ">

So far I can only find this on the Tuple documentation page. This incident is also similar to the Design of Networking mistake recently posted.

Reproduction Steps
This page has some broken HTML at the top of the page:

Expected Behavior
The page to not contain broken HTML

Actual Behavior
The page contains broken HTML. Nothing that breaks the content, though.

Issue Area: Roblox Website
Page URL: HapticService:SetMotor
Impact: Low
Frequency: Constantly

ParticleEmitter/Emit has a misspelling and thus broken link in the first sentence of the description:

The Emit method will cause the ParticleEmitter to emit the given number of particles similar to how ParticleEmitter.Rate does on ParticleEmitter/Enalbed emitters.

ParticleEmitter/Enalbed should be ParticleEmitter/Enabled

https://developer.roblox.com/en-us/api-reference/function/ParticleEmitter/Emit

It should be “it became effective” since it is now two years past that date.

Although it’s a minor edit, this mention makes ALL the difference in understanding data limits in the DataStore.
Nowhere in the official DataStore documentation is it clear whether the 4Mb limit is for the entire DataStore (summing all keys), per scope, or per key.
This raises a lot of doubt (as I’ve had so far), where I just confirmed this by finding the announcement of the increased limit to 4Mb, where it mentions that it’s ‘per-key’:

ClickableWhenViewportHidden, in the description(the i shouldn’t be capitalized):

ClickableWhenViewportHidden

Some of the fonts on Fonts Page aren’t working/showing up, they’re just the default font.

As programeow mentions in his/her post, you wrote in the PreloadAsync it only receives instances. But, it clearly can accept URIs like in the example at the bottom of the documentation.

Also, confirmed in this 2017 post, it should accept image URIs

I am unable to create a thread in this category so this is my only option

The example usage of GetRangeAsync is incorrect

function PrintAllKeys(map)
    -- the initial lower bound is nil which means to start from the very first item
    local exclusiveLowerBound = nil
 
    -- this loop continues until the end of the map is reached
    while true do
        -- get up to a hundred items starting from the current lower bound
        local items = map:GetRangeAsync(Enum.SortDirection.Ascending, 100, exclusiveLowerBound)
        
        -- print all keys retrieved in this call
        for _, entry in ipairs(items) do
            print(item.key) -- this line is using a variable that doesn't exist
        end
 
        -- if the call returned less than a hundred items it means we’ve reached the end of the map
        if #items < 100 then
            break
        end
 
        -- the last retrieved key is the exclusive lower bound for the next iteration
        exclusiveLowerBound = items[#items].key
    end
end

The line with “print(item.key)” uses the variable “item” which doesn’t exist anywhere in the example. There is also no documentation on how the returned array is formatted which is (from my knowledge):

{
    {
        ["key"] = "some key",
        ["value"] = "some value"
    },
    {
        ["key"] = "some key",
        ["value"] = "some value"
    }
}

the GetNameFromUserIdAsync() API reference code example shows the incorrect code example it shows the " Playing in Third Person" code sample instead of the " GetNameFromUserIdAsync" code sample. Please fix it if you have the ability to.

1 Like

Roblox Star Program states the following:

‘Ability to direct from Social Links on the experiences page, to the Amazon Store’

The above line is missing an apostrophe and should actually be the following:

‘Ability to direct from Social Links on the experience’s page, to the Amazon Store’

The article links in the note at the top of Chat:SetBubbleChatSettings are broken

https://developer.roblox.com/en-us/api-reference/function/Chat/FilterStringAsync

In the red warning it states that developer ‘maybe subject to moderation action’, this should be ‘may be subject to moderation action’

https://developer.roblox.com/en-us/api-reference/function/Chat/FilterStringAsync
The first word in the description is:
FilterStringAsyc
While it should be:
FilterStringAsync

https://developer.roblox.com/en-us/api-reference/function/Chat/FilterStringForBroadcast

This article does not put the note shown at the end of the description in a red box and it also does not put the fact that localscript use is deprecated in a yellow box unlike https://developer.roblox.com/en-us/api-reference/function/Chat/FilterStringAsync

Also, both articles use the word ‘games’ rather than ‘experiences’.

https://developer.roblox.com/en-us/api-reference/property/Model/WorldPivot
Missing end paren in code block:

model:PivotTo(CFrame.new(0, 10, 0)  -- This works without needing to explicitly set "model.WorldPivot"

Should be:

model:PivotTo(CFrame.new(0, 10, 0))  -- This works without needing to explicitly set "model.WorldPivot"
1 Like

There should be a space between Game Settings and menu. Here’s how it currently looks:

Also, in the Awarding a Badge snippet, there is an erroneous end) at line 11 that should not be there:


A similar issue occurs in the Checking Earned Badges snippet:

1 Like

https://developer.roblox.com/en-us/api-reference/function/Player/RequestStreamAroundAsync

Broken link to the RemoteEvents page under the Code Samples, Streaming Requests section.

https://developer.roblox.com/en-us/api-reference/event/UserInputService/WindowFocusReleased

RemoteEvents are called ‘RemoveEvents’ is this API reference. Also, it says ‘name’ rather than ‘named’…