docs: improve type annotations

Author: tomodachi94

unicorn/core.lua

@@ -62,7 +62,7 @@ end
 --- Checks if a conflicting version of a package is installed.
 -- This checks if there is an equivalent or higher version of a package is installed.
 -- If one is not detected, installation continues.
----@param package_table A valid package table
+---@param package_table table A valid package table
 local function check_installable(package_table)
 	local existing_package = getPackageData(package_table.name)
 	if existing_package then
@@ -101,8 +101,8 @@ local function action_modular_providers(package_table)
 end
 
 --- Gets "package_script_name" from "package_table.script" and runs it.
----@param package_table A valid package table
----@param package_script_name A value that is either "preinstall", "postinstall", "preremove", or "postremove".
+---@param package_table table A valid package table
+---@param package_script_name string A value that is either "preinstall", "postinstall", "preremove", or "postremove".
 local function action_script(package_table, package_script_name)
 	if package_table.script and package_table.script[package_script_name] then
 		local output, scriptError = load(package_table.script[package_script_name])()
@@ -117,13 +117,13 @@ end
 local function action_check_hashes(package_table)
 	if package_table.security and package_table.security.sha256 then
 		for k, v in pairs(package_table.security.sha256) do
-			local digest = sha256.digest(fs.open(k, "r"):readAll())
+			local digest = sha256.digest(fs.open(k, "r"):readAll()):toHex()
 			assert(digest, v)
 		end
 	end
 end
 --- Creates folders from package_table.dirs
----@param package_table A valid package table
+---@param package_table table A valid package table
 local function action_make_folders(package_table)
 	if package_table.dirs then
 		for _, v in pairs(package_table.dirs) do

unicorn/remote.lua

@@ -22,6 +22,8 @@ unicorn.remote = {}
 --- Installs MCJack123's AUKit, assuming a remote hosting it is configured.
 --- >>> local unicorn = require("unicorn")
 --- >>> unicorn.remote.install("aukit")
+---@param package_name string The name of the package
+---@return nil
 function unicorn.remote.install(package_name)
 	local downloaded = false
 	while not downloaded do

unicorn/util.lua

@@ -7,6 +7,7 @@ unicorn.util = {}
 
 ---@description Returns contents of HTTP(S) request
 ---@param url string A valid HTTP or HTTPS URL.
+---@return string The content from the request
 function unicorn.util.smartHttp(url)
 	unicorn.util.logging.debug("Connecting to " .. url .. "... ")
 
@@ -39,6 +40,7 @@ end
 ---@type table
 --- @doctype const
 unicorn.util.sandbox_env = {
+	---@diagnostic disable: deprecated
 	-- Source: https://stackoverflow.com/a/6982080 (with gentle modifications)
 	ipairs = ipairs,
 	next = next,
@@ -93,6 +95,7 @@ unicorn.util.sandbox_env = {
 		tan = math.tan,
 		tanh = math.tanh,
 	},
+	---@diagnostic enable: deprecated
 }
 
 --- Load some Lua code in a sandboxed environment.