Some more improvements

senS24th · web-flow · commit 8c8203c19bb2 · 2025-04-13T05:50:12.000+02:00
Improvements
diff --git a/docs/Debug/setconstant.md b/docs/Debug/setconstant.md
@@ -29,7 +29,6 @@ local function dummy_function()
     print(game.Name)
 end
 
--- Overwrite the constant at index 4 with "Players"
 debug.setconstant(dummy_function, 4, "Players")
 
 dummy_function() -- Output: Players
diff --git a/docs/Debug/setstack.md b/docs/Debug/setstack.md
@@ -26,7 +26,7 @@ function debug.setstack(level: number, index: number, value: any): ()
 
 ### Example 1
 
-```luau title="Replacing a function on the stack" linenums="1"
+```luau title="Replacing the 'error' function on the stack with our own" linenums="1"
 error(debug.setstack(1, 1, function()
     return function()
         print("Replaced")
diff --git a/docs/Drawing/README.md b/docs/Drawing/README.md
@@ -44,7 +44,7 @@ All drawing object types inherit the following fields:
 
 | Method Signature                        | Description                           |
 |----------------------------------------|---------------------------------------|
-| `#!luau Drawing:Destroy()` | Permanently removes the drawing from view. |
+| `#!luau Destroy()` | Permanently removes the drawing from view. |
 
 ---
 
diff --git a/docs/Environment/getgc.md b/docs/Environment/getgc.md
@@ -1,6 +1,6 @@
 # `getgc`
 
-`#!luau getgc` returns a list of **non-dead garbage-collectable values**. These include functions, userdata, and optionally tables.
+`#!luau getgc` returns a list of **non-dead garbage-collectable values**. These include functions, userdatas, and optionally tables.
 
 ```luau
 function getgc(includeTables: boolean?): { { any } | (...any) -> (...any) | userdata }
diff --git a/docs/Environment/getgenv.md b/docs/Environment/getgenv.md
@@ -1,6 +1,7 @@
 # `getgenv`
 
 !!! warning "getgenv polluting"
+
     Modifications to a thread's global environment should not affect `#!luau getgenv`.
 
 `#!luau getgenv` returns the **executor's global environment table**, which is shared across all executor-made threads.
@@ -21,10 +22,14 @@ function getgenv(): { any }
 
 ## Example
 
-```luau title="Storing values across scripts using getgenv" linenums="1"
-getgenv().shared_var = "hello world"
+```luau title="getgenv shouldn't be affected by the global table/getfenv" linenums="1"
+getgenv().dummy_val = "value"
+getfenv().dummy_val_2 = 1
+
+print(dummy_val, getgenv().dummy_val_2) -- Output: value, 1
+
+getgenv().dummy_val = "value2"
+dummy_val = nil
+print(dummy_val) -- Output: value2
 
-task.spawn(function()
-    print(shared_var) -- Output: hello world
-end)
 ```
diff --git a/docs/Instances/getcallbackvalue.md b/docs/Instances/getcallbackvalue.md
@@ -31,5 +31,4 @@ local retrieved = getcallbackvalue(dummy_bindable, "OnInvoke")
 retrieved() -- Output: Hello from callback!
 
 print(getcallbackvalue(dummy_remote_function, "OnClientInvoke")) -- Output: nil
-getcallbackvalue(dummy_remote_function, "") -- Throws an error
 ```
diff --git a/docs/Reflection/setscriptable.md b/docs/Reflection/setscriptable.md
@@ -2,7 +2,7 @@
 
 !!! warning "Detection risks"
 
-    `#!luau setscriptable` can expose detection vectors. Games may check whether certain properties are unexpectedly accessible, which can lead to detection.
+    `#!luau setscriptable` can expose detection vectors. Games may check whether certain properties are unexpectedly accessible, which can lead to detections.
 
 !!! info "Limited property support"
 
diff --git a/docs/Scripts/getcallingscript.md b/docs/Scripts/getcallingscript.md
@@ -2,7 +2,7 @@
 
 !!! info "Notes on `#!luau getcallingscript`"
 
-    If a game script is executing and `#!luau getcallingscript` is called, it must return the proper [`Script`](https://create.roblox.com/docs/reference/engine/classes/Script), [`LocalScript`](https://create.roblox.com/docs/reference/engine/classes/LocalScript), or [`ModuleScript`](https://create.roblox.com/docs/reference/engine/classes/ModuleScript) - even if the [`#!luau script`](https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#script) global for said script is set to `#!luau nil`.
+    If a game script is executing, and `#!luau getcallingscript` is called, it must return the proper [`Script`](https://create.roblox.com/docs/reference/engine/classes/Script), [`LocalScript`](https://create.roblox.com/docs/reference/engine/classes/LocalScript), or [`ModuleScript`](https://create.roblox.com/docs/reference/engine/classes/ModuleScript) - even if the [`#!luau script`](https://create.roblox.com/docs/reference/engine/globals/RobloxGlobals#script) global for said script is set to `#!luau nil`.
 
 `#!luau getcallingscript` returns the [`#!luau Script`](https://create.roblox.com/docs/reference/engine/classes/Script), [`#!luau LocalScript`](https://create.roblox.com/docs/reference/engine/classes/LocalScript), or [`#!luau ModuleScript`](https://create.roblox.com/docs/reference/engine/classes/ModuleScript) that **triggered the current code execution**.
 
@@ -26,13 +26,13 @@ local old; old = hookmetamethod(game, "__index", function(self, key)
         local caller = getcallingscript()
         warn("__index access from script:", caller and caller:GetFullName() or "Unknown")
 
-        hookmetamethod(game, "__index", old) -- restore ze original
+        hookmetamethod(game, "__index", old) -- Restore the original
         return old(self, key)
     end
 
-    return old(self, key) -- ensure executor access still works after ts
+    return old(self, key)
 end)
 
-print(getcallingscript()) -- Output: nil bc called from executor thread
+print(getcallingscript()) -- Output: nil, since we called from an executor thread
 
 ```
diff --git a/docs/Scripts/getscriptclosure.md b/docs/Scripts/getscriptclosure.md
@@ -1,8 +1,8 @@
 # `getscriptclosure`
 
-!!! info "Closure is compiled from bytecode, not an active one"
+!!! info "Closure is compiled from the script's bytecode, not an active one"
 
-    The function returned by `#!luau getscriptclosure` is a **new closure** compiled from the script's bytecode. It is not the function used by the game script, but has identical metadata. This function is used to retrieve constants from a script.
+    The function returned by `#!luau getscriptclosure` is a **new closure** compiled from the script's bytecode. It is not the function used by the game script, but has identical metadata. This function is usually used to retrieve constants from a script.
 
 !!! info "Not all scripts have bytecode"
 
diff --git a/docs/Scripts/getsenv.md b/docs/Scripts/getsenv.md
@@ -9,7 +9,7 @@
 This environment contains **all global variables, functions** available to the target script, such as custom-defined functions or state values.
 
 ```luau
-function getsenv(script: Script | LocalScript | ModuleScript): { [any]: any }
+function getsenv(script: BaseScript | ModuleScript): { [any]: any }
 ```
 
 ## Parameters
diff --git a/docs/Scripts/loadstring.md b/docs/Scripts/loadstring.md
@@ -4,24 +4,28 @@
 
     Compiles the given string, and returns it runnable in a function. The environment must become unsafe after this function is called due to it allowing the modification of globals uncontrollably (see [setfenv](https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#setfenv)/[getfenv](https://create.roblox.com/docs/reference/engine/globals/LuaGlobals#getfenv) documentation).
 
+!!! info "Notes on `loadstring`"
+
+    If the source compiles sucecssfully, you will get a runnable function that, when called, will execute the source you provided along with the passed arguments. If the source fails to compile, you will instead receive `#!luau nil` alongside the error, explaining what went wrong.
+
 ```luau
-function loadstring<A..., T...>(source: string, chunkname: string?): (((A...) -> T...) | nil, string?)
+function loadstring<A...>(source: string, chunkname: string?): (((A...) -> any) | nil, string?)
 ```
 
 ## Parameters
 
 | Parameter         | Description                                                                 |
 |-------------------|-----------------------------------------------------------------------------|
 | `#!luau source`        | The source code string to compile.                                           |
-| `#!luau chunkname?` | *(Optional)* Custom chunk name |
+| `#!luau chunkname?`    | Custom chunk name. |
 
 ---
 
 ## Examples
 
 ### Example 1
 
-```luau title="Compiling and running source code" linenums="1"
+```luau title="Compiling and running source code successfully" linenums="1"
 loadstring([[
     placeholder = {"Example"}
 ]])()
@@ -33,7 +37,7 @@ print(placeholder[1]) -- Output: Example
 
 ### Example 2
 
-```luau title="Using a custom chunk name" linenums="1"
+```luau title="Using a custom chunk name while also getting an error" linenums="1"
 local func, err = loadstring("Example = ", "CustomChunk")
 
 print(func) -- Output: nil
diff --git a/docs/Signals/Connection.md b/docs/Signals/Connection.md
@@ -12,11 +12,11 @@ A `#!luau Connection` object represents an active link to a signal's callback. T
 
 | Field               | Type        | Description                                                                 |
 |---------------------|-------------|-----------------------------------------------------------------------------|
-| `#!luau Enabled`       | `boolean`   | Whether the connection is currently active and will respond to events.     |
-| `#!luau ForeignState`  | `boolean`   | `#!luau true` if the connection was made from a foreign Lua state (e.g. CoreScript). |
-| `#!luau LuaConnection` | `boolean`   | `#!luau true` if the connection was created from Luau, not C or foreign code.        |
-| `#!luau Function`      | `function?` | The bound function, or `#!luau nil` if foreign or non-Luau.                        |
-| `#!luau Thread`        | `thread?`   | The thread that created the connection, or `#!luau nil` in foreign contexts.       |
+| `#!luau Enabled`       | `boolean`               | Whether the connection is currently active and will respond to events.     |
+| `#!luau ForeignState`  | `boolean`               | `#!luau true` if the connection was made from a foreign Lua state (e.g. CoreScript). |
+| `#!luau LuaConnection` | `boolean`               | `#!luau true` if the connection was created from Luau, not C or foreign code.        |
+| `#!luau Function`      | `(...any) -> (...any)?` | The bound function, or `#!luau nil` if foreign or non-Luau contexts.                        |
+| `#!luau Thread`        | `thread?`               | The thread that created the connection, or `#!luau nil` in foreign or non-Luau contexts.       |
 
 !!! info "Foreign and C-state behavior"
 
diff --git a/docs/Signals/firesignal.md b/docs/Signals/firesignal.md
@@ -15,7 +15,7 @@ function firesignal(signal: RBXScriptSignal, ...: any?)
 | Parameter         | Description                                            |
 |------------------|--------------------------------------------------------|
 | `#!luau signal`    | The signal whose connections you want to manually fire. |
-| `#!luau ...`       | The arguments to pass to the connected functions.       |
+| `#!luau ...?`       | The arguments to pass to the connected functions.       |
 
 ---
 
diff --git a/docs/WebSocket/README.md b/docs/WebSocket/README.md
@@ -1,4 +1,4 @@
-get# WebSocket class
+# WebSocket class
 
 The `#!luau WebSocket` class provides a lightweight interface for establishing and working with WebSocket connections. It allows scripts to **send** and **receive** messages over a persistent connection to a [WebSocket](https://en.wikipedia.org/wiki/WebSocket) server.
 
