Merge branch 'main' into General-Iteration-#2

Author: IgnisRBX

content/en-us/luau/queues.md

@@ -58,20 +58,20 @@ function Queue.new<T>(): Queue<T>
 end
 
 -- Check if the queue is empty
-function Queue.IsEmpty<T>(self: Queue<T>)
+function Queue.isEmpty<T>(self: Queue<T>)
 	return self._first > self._last
 end
 
 -- Add a value to the queue
-function Queue.Enqueue<T>(self: Queue<T>, value: T)
+function Queue.enqueue<T>(self: Queue<T>, value: T)
 	local last = self._last + 1
 	self._last = last
 	self._queue[last] = value
 end
 
 -- Remove a value from the queue
-function Queue.Dequeue<T>(self: Queue<T>): T
-	if self:IsEmpty() then
+function Queue.dequeue<T>(self: Queue<T>): T
+	if self:isEmpty() then
 		error("Cannot dequeue from empty queue")
 	end
 
@@ -96,27 +96,27 @@ local Queue = require(ReplicatedStorage:WaitForChild("Queue"))
 local myQueue = Queue.new()
 
 -- Add some values to the queue
-myQueue:Enqueue(5)
-myQueue:Enqueue(10)
-myQueue:Enqueue(15)
+myQueue:enqueue(5)
+myQueue:enqueue(10)
+myQueue:enqueue(15)
 
 -- myQueue = { 5, 10, 15 }
 
 -- Remove one value from the queue
-local first = myQueue:Dequeue()
+local first = myQueue:dequeue()
 print("The first value added to the queue was", first)
 
 -- myQueue = { 10, 15 }
 
 -- Add more values to the queue
-myQueue:Enqueue(20)
-myQueue:Enqueue(25)
-myQueue:Enqueue(30)
+myQueue:enqueue(20)
+myQueue:enqueue(25)
+myQueue:enqueue(30)
 
 -- myQueue = { 10, 15, 20, 25, 30 }
 
 -- Remove another value from the queue
-local second = myQueue:Dequeue()
+local second = myQueue:dequeue()
 print("The second value added to the queue was", second)
 
 -- myQueue = { 15, 20, 25, 30 }

content/en-us/luau/stacks.md

@@ -26,18 +26,18 @@ function Stack.new()
 end
 
 -- Check if the stack is empty
-function Stack:IsEmpty()
+function Stack:isEmpty()
 	return #self._stack == 0
 end
 
 -- Put a new value onto the stack
-function Stack:Push(value)
+function Stack:push(value)
 	table.insert(self._stack, value)
 end
 
 -- Take a value off the stack
-function Stack:Pop()
-	if self:IsEmpty() then
+function Stack:pop()
+	if self:isEmpty() then
 		return nil
 	end
 
@@ -57,21 +57,21 @@ local s = Stack.new()
 
 -- Change the stack 	Resulting stack		 Output
 
-s:Push(1)      			-- {1}
+s:push(1)      			-- {1}
 
-s:Push(5)      			-- {1, 5}
+s:push(5)      			-- {1, 5}
 
-s:Push(10)     			-- {1, 5, 10}
+s:push(10)     			-- {1, 5, 10}
 
-print(s:Pop()) 			-- {1, 5}            10
+print(s:pop()) 			-- {1, 5}            10
 
-print(s:Pop()) 			-- {1}               5
+print(s:pop()) 			-- {1}               5
 
-s:Push(20)     			-- {1, 20}
+s:push(20)     			-- {1, 20}
 
-print(s:Pop()) 			-- {1}               20
+print(s:pop()) 			-- {1}               20
 
-print(s:Pop()) 			-- {}                1
+print(s:pop()) 			-- {}                1
 ```
 
 <Alert severity="warning">

content/en-us/luau/tables.md

@@ -141,9 +141,9 @@ To create a dictionary table, define each **key** followed by `=` and the **valu
 
 ```lua
 local testDictionary = {
-	FruitName = "Lemon",
-	FruitColor = "Yellow",
-	Sour = true
+	fruitName = "Lemon",
+	fruitColor = "Yellow",
+	sour = true
 }
 ```
 
@@ -153,7 +153,7 @@ The keys for dictionaries can be numbers, strings, and objects. For example, a k
 local part = Instance.new("Part")
 
 local testDictionary = {
-	PartType = "Block",
+	partType = "Block",
 	[part] = true
 }
 ```
@@ -166,11 +166,11 @@ To read from a dictionary, add a pair of brackets after its reference and specif
 local part = Instance.new("Part")
 
 local testDictionary = {
-	PartType = "Block",
+	partType = "Block",
 	[part] = true
 }
 -- Include quotes for string keys
-print(testDictionary["PartType"]) -- Block
+print(testDictionary["partType"]) -- Block
 -- Omit quotes for non-string keys
 print(testDictionary[part]) -- true
 ```
@@ -181,20 +181,20 @@ To define or rewrite the value of a new or existing dictionary key, declare the
 
 ```lua
 local testDictionary = {
-	FruitName = "Lemon",
-	Sour = true
+	fruitName = "Lemon",
+	sour = true
 }
 
 -- Change value of existing keys
-testDictionary["FruitName"] = "Cherry"
-testDictionary["Sour"] = false
+testDictionary["fruitName"] = "Cherry"
+testDictionary["sour"] = false
 
 -- Insert new key-value pair
-testDictionary["FruitCount"] = 10
+testDictionary["fruitCount"] = 10
 
-print(testDictionary["FruitName"]) -- Cherry
-print(testDictionary["Sour"]) -- false
-print(testDictionary["FruitCount"]) -- 10
+print(testDictionary["fruitName"]) -- Cherry
+print(testDictionary["sour"]) -- false
+print(testDictionary["fruitCount"]) -- 10
 ```
 
 ### Iterating over Dictionaries
@@ -203,19 +203,19 @@ To iterate over a dictionary, use the global `pairs()` function in a `for` loop:
 
 ```lua
 local testDictionary = {
-	FruitName = "Lemon",
-	FruitColor = "Yellow",
-	Sour = true
+	fruitName = "Lemon",
+	fruitColor = "Yellow",
+	sour = true
 }
 
 for key, value in pairs(testDictionary) do
 	print(key, value)
 end
 
 --[[ Resulting output:
-FruitName Lemon
-Sour true
-FruitColor Yellow
+fruitName Lemon
+sour true
+fruitColor Yellow
 ]]
 ```
 
@@ -229,19 +229,19 @@ To remove or erase a key-value pair from a dictionary, set its value for a key t
 
 ```lua
 local testDictionary = {
-	FruitName = "Lemon",
-	FruitColor = "Yellow",
-	Sour = true
+	fruitName = "Lemon",
+	fruitColor = "Yellow",
+	sour = true
 }
 
-testDictionary["Sour"] = nil
+testDictionary["sour"] = nil
 
 for key, value in pairs(testDictionary) do
 	print(key, value)
 end
 --[[ Resulting output:
-FruitName Lemon
-FruitColor Yellow
+fruitName Lemon
+fruitColor Yellow
 ]]
 ```
 

content/en-us/reference/engine/enums/RollOffMode.yaml

@@ -15,21 +15,26 @@ items:
   - name: Inverse
     summary: |
       Volume attenuates from `Class.Sound.RollOffMinDistance` in an inverse
-      manner. This option mirrors how sounds attenuate in the real world.
+      manner, mirroring how sounds attenuate in the real world.
+      This is done through `Class.Sound.RollOffMinDistance`/`distance`,
+      where `distance` is the `Datatype.Vector3.Magnitude` between the audio source and the audio listener.
     value: 0
     tags: []
     deprecation_message: ''
   - name: Linear
     summary: |
       Volume attenuates between `Class.Sound.RollOffMinDistance` and
       `Class.Sound.RollOffMaxDistance` with a linear relationship.
+      This is done through (`Class.Sound.RollOffMaxDistance`/`distance`)/(`Class.Sound.RollOffMaxDistance`-`Class.Sound.RollOffMinDistance`),
+      where `distance` is the `Datatype.Vector3.Magnitude` between the audio source and the audio listener.
     value: 1
     tags: []
     deprecation_message: ''
   - name: LinearSquare
     summary: |
       Volume attenuates between `Class.Sound.RollOffMinDistance` and
       `Class.Sound.RollOffMaxDistance` with a linear squared relationship.
+      This is done through squaring `Linear`.
     value: 2
     tags: []
     deprecation_message: ''
@@ -38,6 +43,7 @@ items:
       A hybrid model which follows the `Inverse` model when close to
       `Class.Sound.RollOffMinDistance` and the `LinearSquare` model when close
       to `Class.Sound.RollOffMaxDistance`.
+      This is done by taking the lesser of `Inverse` and `LinearSquare`.
     value: 3
     tags: []
     deprecation_message: ''