Typos & Minor Edits Mega-thread

SubtotalAnt8185 · February 7, 2023, 5:32am

There is an unintentional space before the period in this documentation about SoundService:

StrongBigeMan9 · February 9, 2023, 5:07am

All of the highlighted typos / possible errors in this post are from the `Player` object documentation page, as of February 8th, 2023.

For reference, any text that is bold within the “Recommended Edits” portion of each section indicates where something was changed from the original text.

Section #1 - `Player` object description

In the first sentence of the description of the Player object, a word is missing between “object” and “a”.

Recommended Edit:

A player object is a client that is currently connected.

In the third paragraph, the word “service” is missing after the hyperlink to the Players documentation page. Adding the word “service” for clarification would make it easier to understand and would keep it consistent with the 2 other sentences where the service is referenced on its own.

Recommended Edit:

There are several similar methods in the Players service for working with Player objects.

Section #2 - `Player.AutoJumpEnabled` property description

In the second sentence of the second paragraph, An apostrophe is missing after the word “Character”, which would be needed to show that it’s talking about an individual Character’s Humanoid.

Recommended Edit:

Then, this property determines the value of the Humanoid.AutoJumpEnabled property of the Player.Character’s Humanoid on spawn.

Section #3 - `Player.CharacterAppearanceId` property description

In the first sentence of the description, the hyperlink to the Character section of the page wasn’t added and its code block was not closed off at the correct spot. This also caused the hyperlinks to the Player object and Player.UserId property to be incorrectly formatted in the second sentence.

Recommended Edit:

This property determines the user ID of the account whose character appearance is used for a player’s Character. By default, this property is the Player's Player.UserId, which uses the player’s avatar as they have created it on the Roblox website.

Section #4 - `Player.DevComputerCameraMode` property description

At the end of the first sentence, the word “device” is repeated two times. I have two recommended changes to this depending on what the intended meaning is:

Recommended Edit

The DevComputerCameraMode property determines the manner in which a player moves their camera when using a device with a mouse-and-keyboard.

If that would affect the meaning of existing content too much, then this would be a more reasonable change:

Alternative Recommended Edit

The DevComputerCameraMode property determines the manner in which a player moves their camera when using a mouse-and-keyboard device.

Section #5 - `Player.DevComputerMovementMode` property description

The same potential typo from Section #4 happens at the end of the first sentence in the Player.DevComputerMovementMode property section, where the word “device” is repeated two times.

Once again, I have two recommended changes to this depending on what the intended meaning is:

Recommended Edit

The DevComputerMovementMode property determines the manner in which a player moves their character when using a device with a mouse-and-keyboard.

If that would affect the meaning of existing content too much, then this would be a more reasonable change:

Alternative Recommended Edit

The DevComputerMovementMode property determines the manner in which a player moves their character when using a mouse-and-keyboard device.

Section #6 - `Player.DevEnableMouseLock` property description

In the second sentence of the second paragraph, the word “the” is missing between “and character”.

Recommended Edit

Moving the mouse will orbit the camera around the player’s character, and the character will face the same direction as the camera.

Section #7 - `Player.DisplayName` property description

There are three separate errors in this section, all of which are related to hyperlinks.

In the first bullet point of the description, a hyperlink to Player.Name is included but navigating to it does not bring you to a description of the property, as no dedicated section documenting the Player.Name property currently exists on the page.
In the second bullet point of the description, both LoadCharacter and the first mention of DisplayName (which is referring to a property of the Humanoid object) were wrapped in a codeblock but without hyperlinks, even though documentation exists for both of those.

Recommended Edit

Characters generated with LoadCharacter or by the Roblox engine will have their Humanoid’s DisplayName property assigned to the Player’s DisplayName property.

Section #8 - `Player.TeamColor` property description

Toward the end of the second paragraph, there was an extra letter “s” added to the word “team”.

Recommended Edit

Setting this property often leads to repetition of the same BrickColor value for a certain team across many scripts; this is something you want to avoid when adhering to the don’t-repeat-yourself principle.

Section #9 - `Player:GetJoinData` method description

Several of the descriptions in the Player.GetJoinData section could have hyperlinks to referenced properties / relevant guides for improved accessibility.

Recommended Edits

(For the description of “SourceGameId”)

The DataModel.GameId of the experience the Player teleported from.

(For the description of “SourcePlaceId”)

The DataModel.PlaceId of the place the Player teleported from. Only present if the player teleports to the current place and a server calls the teleport function.

(For the description of “Members”)

An array containing the UserId numbers of the users teleported alongside the Player. Only present if the player teleported as part of a group.

(For the second image, at the end of the “GetJoinData and TeleportData” sub-section)

As this data is transmitted by the client, it can still potentially be abused by an exploiter. Sensitive data such as player currency should be transmitted via a secure solution like Memory Stores.

(For the third image directly above, in the “LaunchData” sub-section, “roblox” should be capitalized to “Roblox”)

You can also make sure that this link works for users without Roblox downloaded on their mobile devices…

Section #10 - `Player:SetSuperSafeChat()` method description

In the second sentence of the description, an unnecessary apostrophe was added to the word “players”. In the sentence that follows that, the word “enable” was written in the incorrect tense (it should be “enable”, not “enabled”).

Recommended Edit

SuperSafeChat is a chat mode where players cannot see unfiltered messages.

For example, entering the following command in the command prompt would enable SuperSafeChat for the player named polarpanda16, as long as that player is in the game:

Section #11 - `Player:GetFriendsOnline` method description

The hyperlink to the DisplayName documentation section was formatted incorrectly. This can be found within the table that lists the expected values to be returned from the Player:GetFriendsOnline method, specifically in the description for the “DisplayName” argument (the third from the top).

Recommended Edit

The Player.DisplayName of the friend.

Section #12 - `Player:IsFriendsWith` method description

In the second sentence, “userId” is wrapped in a codeblock with the incorrect capitalization and no hyperlink to the Player.UserId property it’s referring to. The incorrect capitalization is also included in the “Parameters” section directly below the description.

Recommended Edit

This function caches results so multiple calls of the function on the same player with the same UserId may not yield the most up-to-date result. This does not happen when used in a LocalScript.

Section #13 - `Player:LoadCharacter` method description

In the last sentence of the third paragraph, the word “script” is not plural nor is there a hyperlink to its documentation page.

Recommended Edit

Also, this function can be used in Scripts, while LoadCharacterBlocking cannot.

Alternative Recommended Edit

Also, this function can be used in a Script, while LoadCharacterBlocking cannot.

Section #14 - `Player.CharacterAdded` Event Description

In the third paragraph of the description, the deprecated Hat object was referenced as an example clothing item, whereas the equivalent and currently-used Accessory object would be more relevant to include. Additionally, a grammatical error exists at the same part of the sentence: "Hats and Shirts, and Pants…"

Recommended Edit

Note that the Humanoid and its default body parts (head, torso, and limbs) will exist when this event fires, but clothing items like Accessories, Shirts, and Pants may take a few seconds to be added to the character.

Section #15 - `Player.CharacterAppearanceLoaded` Event Description

The first sentence of the second paragraph has a grammatical error: “Player.Character's generally have…”

Later on in the sentence, the Accoutrement object is mentioned as a example object that can modify the Character’s appearance. However, similar to the example from Section #14, the equivalent and currently-used Accessory object would be more relevant to include.

Then, in the first sentence of the third paragraph, “Characters” is missing an apostrophe to properly describe the relationship between the Character and its appearance; the description is currently using the plural form of the word “Character”.

Recommended Edits

Note

In the first recommended edit, a comma was added after “appearance”. I tried to make it bold (to indicate it was an addition / change) but it isn’t formatted correctly while next to another letter**,** like what was demonstrated just there (unless it works by the time you’re reading this).

A Player.Character generally has a range of objects modifying its appearance, including Accessories, Shirts, Pants and CharacterMeshes.

One use for this event, is to remove and save aspects of a Character's appearance to be used later.

Section #16 - `Player.CharacterRemoving` Event Description

The last sentence of the second paragraph is missing the word “to” between “like print”.

Recommended Edit

For instance, if you would like to print a message every time a player spawns and dies:

Section #17 - `Player.Chatted` event description

At the end of the third sentence within the “Chat Commands” section, there’s an extra space added between the closing parentheses and the period.

Recommended Edit

To check for a prefix in a string, use string.sub() on the message to check a substring of the message: string.sub(message, 1, 6) == "/heal " (note the inclusion of the space).

Section #18 - `Player.Idled` event description

In the first sentence of the first paragraph, the reference to the Player object isn’t capitalized (but it should be).

In the last sentence of the fourth paragraph, the word “considering” was written in an incorrect tense.

Recommended Edits

This event is usually fired two minutes after the game engine classifies the Player as idle.

If you would like to track when this disconnect occurs, consider using Players.PlayerRemoving alongside this event.

Section #19 - `Player.SimulationRadiusChanged` event description

In the second sentence of the “What is the SimulationRadius” sub-section, the singular possessive word of Player's was used instead of the more applicable, plural possessive word of Players', as the description specified multiple players and not an individual one.

Important Note

This typo also applies to every other section that has the “What is the SimulationRadius” summary, including the Player.SimulationRadius and Player.MaximumSimulationRadius property descriptions (which I only just realized after noticing the error in the Player.SimulationRadiusChanged description).

Recommended Edit

In cases where a BasePart or assembly is within multiple players’ SimulationRadiuses, the closest player is chosen.

Hope that this ends up being useful! Maybe I’ll continue proofreading various pages throughout the Roblox Creator Documentation in the future since it was pretty interesting; got to learn about the nuances of some features that I hadn’t been aware of beforehand.

TooManyOveralls · February 13, 2023, 6:32pm

Great callouts, thank you! The typos you mentioned are now fixed.

TooManyOveralls · February 13, 2023, 7:03pm

Thank you very much for all of these edits! I’m working on them right now and they should go live soon.

TooManyOveralls · February 13, 2023, 7:04pm

Great catch, I will fix this right now!

JuanGamerPlayz_RBLX · February 13, 2023, 7:19pm

Once clicking on the article where it tells about the ColorShift_Top, it contained a typo regarding Lighting.ColorShift_Bottom as repeating the word “Lighting” one more time:

It was fixed a year ago, but you are not able to get to the article mentioning the ColorShift_Bottom (I know that I should have reported that in the same topic, but it was closed), and yes only have the last parts of the URL link changed.

Issue Area: Lighting | Roblox Creator Documentation

(@TooManyOveralls ^)

TooManyOveralls · February 13, 2023, 7:39pm

Good eye, I’ll fix this right now. You should see the change very soon.

ProBaturay · February 14, 2023, 11:26am

In this article, the word “unpredictable” is misspelled as “unpredicatable”

Dysche · February 14, 2023, 11:48am

Not sure if this is intentional, but the reference to HapticService:SetMotor isn’t highlighted in blue or clickable.

Map1eMoose · February 21, 2023, 5:35am

Under “Requesting Area Streaming”

the code game uses . to call a function instead of :

local function teleportPlayer(player, teleportTarget)
	-- Request streaming around target location
	player.RequestStreamAroundAsync(teleportTarget)
       -- This results in a error: Expected ':' not '.' calling member function RequestStreamAroundAsync

Should be

local function teleportPlayer(player, teleportTarget)
	-- Request streaming around target location
	player:RequestStreamAroundAsync(teleportTarget)

SeargentAUS · February 21, 2023, 9:42am

You can add translations Products such as Badges and Passes…

Should be
“You can add translations for Products such as Badges and Passes…”

Just a heads up, @Map1eMoose:

Code sample errors are among the things not meant to be posted in this thread

SubtotalAnt8185 · February 22, 2023, 9:00pm

Minor edit:

On AnalyticsService’s documentation, it states “… take a look at this DevForum post” with no links to it.

AnalyticsService | Roblox Creator Documentation

Den_vers · February 24, 2023, 5:43am

MicroProfiler is constantly running, analyizing the render time for every frame. To see useful data, you need to pause MircoProfiler and analyze render information on a frame-by-frame basis. Press Ctrl+P to pause the MicroProfiler.

Typo alert!

TooManyOveralls · March 1, 2023, 8:01pm

@ProBaturay @Dysche @Map1eMoose @SeargentAUS @Den_vers

Thank you for catching these! All fixes are going to go live very soon.

TooManyOveralls · March 1, 2023, 8:35pm

Thank you for this report! AnalyticsService is deprecated, I’d recommend using the Analytics Dashboard

Abcreator · March 1, 2023, 10:29pm

Don’t know if this belongs here since it’s not a grammar issue but rather a single word being copy + pasted from the wrong function, while it does change the meaning of the sentence, common sense would make any developer doubt this behaviour

https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#PromptRenameOutfit

PromptRenameOutfit says the following:

Prompts the Players.LocalPlayer to delete the given outfit. Does not yield. The result can be retrieved by listening to the AvatarEditorService.PromptRenameOutfitCompleted event.

This function states that it deletes the outfit like PromptDeleteOutfit but this is not true, it should be changed to the following:

Prompts the Players.LocalPlayer to rename the given outfit. Does not yield. The result can be retrieved by listening to the AvatarEditorService.PromptRenameOutfitCompleted event.

IcyMonstrosity · March 2, 2023, 1:13pm

Alright 2 minor things:

wrong capital letters on https://education.roblox.com for the “Students & FamIlIes”
minor misleading things on Avatar Marketplace Requirements (Avatar Marketplace Requirements | Roblox Creator Documentation), at the bottom of the page it states: “Do not include excessive text on items.” this does not match the documentation that UGC creators got which states that it is only strongly suggestive

msix29 · March 2, 2023, 2:08pm

miss-placing backticks/backquotes in the IK controls page

(right above the Offset property)

ProBaturay · March 2, 2023, 10:53pm

It took me 4 hours to find all of the issues below and 2 hours to format the post. The list shows the categories almost in this order:

1) Repeated words
2) Misspelled words
3) Other grammar issues

All of the issues were found under the Guides title. There are many more mistakes I could not put here. Links will redirect you to the typos or text that should be edited.

Issue #1

The phrase “of detail” is repeated.

Typos & Minor Edits Mega-thread

All of the highlighted typos / possible errors in this post are from the Player object documentation page, as of February 8th, 2023.

Section #1 - Player object description

Section #2 - Player.AutoJumpEnabled property description

Section #3 - Player.CharacterAppearanceId property description

Section #4 - Player.DevComputerCameraMode property description

Section #5 - Player.DevComputerMovementMode property description

Section #6 - Player.DevEnableMouseLock property description

Section #7 - Player.DisplayName property description

Section #8 - Player.TeamColor property description

Section #9 - Player:GetJoinData method description

Section #10 - Player:SetSuperSafeChat() method description

Section #11 - Player:GetFriendsOnline method description

Section #12 - Player:IsFriendsWith method description

Section #13 - Player:LoadCharacter method description

Section #14 - Player.CharacterAdded Event Description

Section #15 - Player.CharacterAppearanceLoaded Event Description

Section #16 - Player.CharacterRemoving Event Description

Section #17 - Player.Chatted event description

Section #18 - Player.Idled event description

Section #19 - Player.SimulationRadiusChanged event description

Important Note

Issue #1

Issue #2

Issue #3

Issue #4

Issue #5

Issue #6

Issue #7

Issue #8

Issue #9

Issue #10

Issue #11

Issue #12

Issue #13

Issue #14

Issue #15

Issue #16

Issue #17

Issue #18

Issue #19

Issue #20

Issue #21

Issue #22

Issue #23

Issue #24

Issue #25

Issue #26

Issue #27

Issue #28

Issue #29

Issue #30

Issue #31

Issue #32

Issue #33

Issue #34

Issue #35

Issue #36

Issue #37

Issue #38

Issue #39

Issue #40

Issue #41

Issue #42

Issue #43

Issue #44

Issue #45

Issue #46

Issue #47

Issue #48

Issue #49

Issue #50

Issue #51

Issue #52

Issue #53

Issue #54

Issue #55

Issue #56

Issue #57

Issue #58

All of the highlighted typos / possible errors in this post are from the `Player` object documentation page, as of February 8th, 2023.

Section #1 - `Player` object description

Section #2 - `Player.AutoJumpEnabled` property description

Section #3 - `Player.CharacterAppearanceId` property description

Section #4 - `Player.DevComputerCameraMode` property description

Section #5 - `Player.DevComputerMovementMode` property description

Section #6 - `Player.DevEnableMouseLock` property description

Section #7 - `Player.DisplayName` property description

Section #8 - `Player.TeamColor` property description

Section #9 - `Player:GetJoinData` method description

Section #10 - `Player:SetSuperSafeChat()` method description

Section #11 - `Player:GetFriendsOnline` method description

Section #12 - `Player:IsFriendsWith` method description

Section #13 - `Player:LoadCharacter` method description

Section #14 - `Player.CharacterAdded` Event Description

Section #15 - `Player.CharacterAppearanceLoaded` Event Description

Section #16 - `Player.CharacterRemoving` Event Description

Section #17 - `Player.Chatted` event description

Section #18 - `Player.Idled` event description

Section #19 - `Player.SimulationRadiusChanged` event description