Skip to content

Commit 742b787

Browse files
authored
Minor corrections and adjustments (#923)
## Changes Fixed typos and revised a few documents to increase clarity & cohesion. ## Checks By submitting your pull request for review, you agree to the following: - [X] This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses. - [X] I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses. - [X] To the best of my knowledge, all proposed changes are accurate. ---------
1 parent 5fe0147 commit 742b787

File tree

5 files changed

+27
-26
lines changed

5 files changed

+27
-26
lines changed

content/en-us/production/localization/automatic-translations.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,22 +27,22 @@ To enable Automatic Text Capture:
2727
<img src="../../assets/localization/Portal-Enable-ATC.png"
2828
width="800" alt="The Localization Settings section highlighting the toggle for Capture text from Experience UI while users play."/>
2929

30-
ATC adds text strings to the localization table within 1-2 minutes of encountering the text in the experience. If you do not want ATC to collect a certain text string, such as a name or unique text entry, disable the `Class.GuiBase2d.AutoLocalize|AutoLocalize` property of the text object.
30+
ATC adds text strings to the localization table within 12 minutes of encountering the text in the experience. If you do not want ATC to collect a certain text string, such as a name or unique text entry, disable the `Class.GuiBase2d.AutoLocalize|AutoLocalize` property of the text object.
3131

3232
<Alert severity="info">
3333
ATC can not capture some experience objects. These objects may require special handling with <a href="./localizing-with-scripting.md">localization scripts</a>. The current exemptions are:
3434
<ul>
35-
<li>The default Roblox leaderboards and chat </li>
36-
<li>Items or tools owned by a player </li>
35+
<li>The default Roblox leaderboards and chat</li>
36+
<li>Items or tools owned by a player</li>
3737
<li>Images with embedded text</li>
3838
<li>Badge names and descriptions pulled from the platform</li>
39-
<li>Game Pass names and descriptions pulled from the platform.</li>
39+
<li>Pass names and descriptions pulled from the platform</li>
4040
</ul>
4141
</Alert>
4242

4343
### Text Capture in Studio
4444

45-
There may be situations in which you need to immediately capture strings to your translation table. In these cases, you can use the text capture tool in Studio to capture strings while playtesting. These strings will be added to the localization table within 1-2 minutes of encountering them.
45+
There may be situations in which you need to immediately capture strings to your translation table. In these cases, you can use the text capture tool in Studio to capture strings while playtesting. These strings will be added to the localization table within 12 minutes of encountering them.
4646

4747
To enable text capture in Studio:
4848

@@ -92,7 +92,7 @@ You can track your automatic translation quota usage on your experience's locali
9292
<img src="../../assets/localization/Automatic-Translation-Quotas.png"
9393
width="800" alt="The Localization Languages section depicting the Automatic Translation Quotas at the top of the page, including the date of the monthly quota renewal." />
9494

95-
Quotas are calculated on a **per-character** and **per-language basis**. For example, translating the source string "hello" into all 15 automatic translation-supported languages will count as 5 x 15 = 75 characters towards your quota.
95+
Quotas are calculated on a **per-character** and **per-language basis**. For example, translating the source string "hello" into all 15 automatic translation-supported languages will count as 5×15 (75) characters towards your quota.
9696

9797
### Automatic Translation Updates
9898

@@ -150,6 +150,9 @@ Roblox supports automatic translation between the languages listed below. Curren
150150
<tr>
151151
<td>Korean</td>
152152
</tr>
153+
<tr>
154+
<td>Polish</td>
155+
</tr>
153156
<tr>
154157
<td>Portuguese</td>
155158
</tr>
@@ -165,9 +168,6 @@ Roblox supports automatic translation between the languages listed below. Curren
165168
<tr>
166169
<td>Turkish</td>
167170
</tr>
168-
<tr>
169-
<td>Polish</td>
170-
</tr>
171171
<tr>
172172
<td>Vietnamese</td>
173173
</tr>

content/en-us/reference/engine/classes/DataStoreService.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ methods:
188188
given prefix.
189189
- name: pageSize
190190
type: int
191-
default: 0
191+
default: 32
192192
summary: |
193193
**(Optional)** Number of items to be returned in each page. By default
194194
is 32.

content/en-us/reference/engine/classes/OrderedDataStore.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ methods:
4141
**minValue**/**maxValue** are optional parameters which filter the
4242
results.
4343
44-
See [Data Stores](../../../cloud-services/data-stores) for request limits
45-
and descriptions of the error codes.
44+
See [Data Stores](../../../cloud-services/data-stores/index.md) for
45+
request limits and descriptions of the error codes.
4646
code_samples:
4747
parameters:
4848
- name: ascending

content/en-us/reference/engine/classes/Terrain.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -475,7 +475,7 @@ methods:
475475
type: CFrame
476476
default:
477477
summary: |
478-
The cframe (position and orientation) of the terrain block.
478+
The position and orientation of the terrain block.
479479
- name: size
480480
type: Vector3
481481
default:
@@ -513,7 +513,7 @@ methods:
513513
type: CFrame
514514
default:
515515
summary: |
516-
The CFrame (position and orientation) of the terrain cylinder.
516+
The position and orientation of the terrain cylinder.
517517
- name: height
518518
type: float
519519
default:

content/en-us/tutorials/fundamentals/coding-5/intro-to-dictionaries.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ next: /tutorials/fundamentals/coding-5/pairs-and-ipairs
55
prev: /tutorials/fundamentals/coding-5/making-changes-to-arrays
66
---
77

8-
Dictionaries are tables that associate names or "\*keys\*\*" with a value instead of an index.
8+
Dictionaries are tables that associate names or **keys** with a value instead of an index.
99

1010
Example:
1111

@@ -16,11 +16,11 @@ local pet = {
1616
}
1717
```
1818

19-
Use dictionaries when you need to label values, not just list them in order as an array does —practice using dictionaries in this tutorial by manipulating values associated with a player.
19+
Use dictionaries when you need to label values, not just list them in order as an array does. Practice using dictionaries in this tutorial by manipulating values associated with a player.
2020

2121
## Dictionary Syntax
2222

23-
Like arrays, dictionaries are assigned to a variable with curly brackets`{}`. **Key value pairs** are stored on separate lines followed by a comma. Keys and values can be any data type, including strings, numbers, and variable names.
23+
Like arrays, dictionaries are assigned to a variable with curly brackets `{}`. **Key-value pairs** are stored on separate lines followed by a comma. Keys and values can be any data type, including strings, numbers, and variable names.
2424

2525
```lua
2626
local playerNames = {
@@ -87,8 +87,9 @@ One everyday use of dictionaries is organizing player or character information.
8787
### Using Dictionary Values
8888

8989
There are two ways to access dictionary values:
90-
`tableName["keyName"]` -- Note the quotations
91-
`tableName.keyName`
90+
91+
- `tableName["keyName"]` (importantly, note the quotations)
92+
- `tableName.keyName`
9293

9394
```lua
9495
local enemy = {
@@ -100,7 +101,7 @@ print("The villain " .. enemy["Name"] .. " approaches!")
100101
print("The villain " .. enemy.Name .. " approaches!")
101102
```
102103

103-
Which style to use usually depends on the purpose of the table. For tables holding a collection of values like a list of players in a server, coders will usually use tableName["keyName"]. For a dictionary used to describe an object, coders are more likely to use tableName.keyName.
104+
Which style to use usually depends on the purpose of the table. For tables holding a collection of values like a list of players in a server, coders will usually use `tableName["keyName"]`. For a dictionary used to describe an object, coders are more likely to use `tableName.keyName`.
104105

105106
## Changing a Dictionary Value
106107

@@ -158,7 +159,7 @@ Dictionaries can interact with pre-existing variables declared in other parts of
158159
end
159160
```
160161

161-
4. Insert name into the `playerPoints` dictionary as a key, and set the value, the player's points, to 0.
162+
4. Insert `name` into the `playerPoints` dictionary as a key, and set the value, the player's points, to 0.
162163

163164
```lua
164165
local function setPoints(newPlayer)
@@ -169,10 +170,10 @@ Dictionaries can interact with pre-existing variables declared in other parts of
169170
```
170171

171172
<Alert severity="warning">
172-
Since `name` was created as a variable, it can be accessed with the actual variable name. If `name` had been simply a key name, it would need to be accessed the same as other strings, playerPoints["name"]
173+
Since `name` was created as a variable, it can be accessed with the actual variable name. If `name` were a key name, it would need to be accessed the same as other strings: `playerPoints["name"]`.
173174
</Alert>
174175

175-
5. Use `name` to print the name of the player and playerPoints[name] to print the value of the key matching the variable.
176+
5. Use `name` to print the name of the player and `playerPoints[name]` to print the value of the key matching the variable.
176177

177178
```lua
178179
local function setPoints(newPlayer)
@@ -183,7 +184,7 @@ Dictionaries can interact with pre-existing variables declared in other parts of
183184
end
184185
```
185186

186-
6. Run the project and look into the output editor.
187+
6. Run the project and observe the output.
187188

188189
```lua title="Finished script"
189190
local Players = game:GetService("Players")
@@ -208,7 +209,7 @@ Below are some challenges that apply to using dictionaries in different ways. Se
208209

209210
- Create a trap part that does damage over time to a player. Once a player touches the trap, damage them, wait, then allow them to be damaged again.
210211
- Create a function that checks which of two players has the most points by accessing a dictionary.
211-
- Create a cipher, a system of swapping one word for another to create a "secret" code, for example, how the letter "A" can be swapped with "G", or how the word apple can be swapped for the word orange.
212+
- Create a cipher, a system of swapping one string for another to create a "secret" code. For example, the letter "A" can be swapped with "G," or the word "apple" can be swapped with "orange."
212213

213214
## Dictionaries and pairs()
214215

@@ -257,7 +258,7 @@ Dictionaries are tables that use key-value pairs instead of indexed values. Dict
257258

258259
All keys within a dictionary should use the same data type, but the values can mix data types without issue.
259260

260-
The style of how a dictionary is accessed can convey the purpose of a dictionary. A dictionary of enemy properties will likely be accessed with the dot operator, while a list of names will likely use tableName[keyName].
261+
The way in which a dictionary is accessed can convey its purpose. A dictionary of enemy properties will likely be accessed with the dot operator, while a list of names will likely use `tableName[keyName]`.
261262

262263
When using brackets, be careful; key names created within the table must be treated as strings: `tableName["keyName"]`. However, when referencing objects like parts, the quotations are not needed: `tableName[keyName]`.
263264

0 commit comments

Comments
 (0)