diff --git a/config/library/init.lua b/config/library/init.lua deleted file mode 100644 index 053350a..0000000 --- a/config/library/init.lua +++ /dev/null @@ -1,11 +0,0 @@ ----@meta - ---- ----This function allows you to write directly to RAM. The requested number of bits is written at the address requested. The address is typically specified in hexadecimal format. ---- ----For in-depth detail on how addressing works with various bits parameters, please see `peek`. ---- ----@param addr number # the address of RAM you desire to write (segmented based on bits) ----@param val number # the integer value write to RAM (range varies based on bits) ----@param bits number # the number of bits to write (1, 2, 4, or 8; default: 8) -function poke(addr, val, bits) end diff --git a/config/library/memory.lua b/config/library/memory.lua index 52384e2..c678a5d 100644 --- a/config/library/memory.lua +++ b/config/library/memory.lua @@ -51,7 +51,7 @@ function peek(addr, bits) end --- ---- `poke` - Write to a memory address --- ----@param bitaddr number # the address of [RAM](RAM) you desire to write +---@param bitaddr number # the address of `RAM` you desire to write ---@return number bitval # the integer value write to RAM function peek1(bitaddr) end @@ -64,7 +64,7 @@ function peek1(bitaddr) end --- ---- `poke` - Write to a memory address --- ----@param addr2 number # the address of [RAM](RAM) you desire to write (segmented on 2) +---@param addr2 number # the address of `RAM` you desire to write (segmented on 2) ---@return number val2 # the integer value write to RAM (segmented on 2) function peek2(addr2) end @@ -77,7 +77,7 @@ function peek2(addr2) end --- ---- `poke` - Write to a memory address --- ----@param addr4 number # the address of [RAM](RAM) you desire to write (segmented on 4) +---@param addr4 number # the address of `RAM` you desire to write (segmented on 4) ---@return number val4 # the integer value write to RAM (segmented on 4) function peek4(addr4) end @@ -104,7 +104,7 @@ function poke(addr, val, bits) end --- ---- `peek` - Read from a memory address --- ----@param bitaddr number # the address of [RAM](RAM) you desire to write +---@param bitaddr number # the address of `RAM` you desire to write ---@param bitval number # the integer value write to RAM function poke1(bitaddr, bitval) end @@ -117,7 +117,7 @@ function poke1(bitaddr, bitval) end --- ---- `peek` - Read from a memory address --- ----@param addr2 number # the address of [RAM](RAM) you desire to write (segmented on 2) +---@param addr2 number # the address of `RAM` you desire to write (segmented on 2) ---@param val2 number # the integer value write to RAM (segmented on 2) function poke2(addr2, val2) end @@ -130,7 +130,7 @@ function poke2(addr2, val2) end --- ---- `peek` - Read from a memory address --- ----@param addr4 number # the address of [RAM](RAM) you desire to write (segmented on 4) +---@param addr4 number # the address of `RAM` you desire to write (segmented on 4) ---@param val4 number # the integer value write to RAM (segmented on 4) function poke4(addr4, val4) end diff --git a/generate.py b/generate.py index 987b156..478fdd2 100755 --- a/generate.py +++ b/generate.py @@ -188,7 +188,7 @@ def get_variable_descriptions(root: MarkdownSection) -> dict[str, str]: if line.startswith("* **") or line.startswith("- **"): names, description = parse_variable_description_line(line) for name in names: - descriptions[name] = description + descriptions[name] = replace_relative_links(description) # TYPO: Because a line explaning the variable "value" in `peek` is missing, # It is hard-coded here @@ -198,11 +198,11 @@ def get_variable_descriptions(root: MarkdownSection) -> dict[str, str]: # TYPO: Because "bitaddr", "bitval", "addr2", "addr4", "val2", "val4" are # not explicitly explained in `peek` and `poke`, it is hard-coded here if root.name == "peek*" or root.name == "poke*": - descriptions["bitaddr"] = "the address of [RAM](RAM) you desire to write" + descriptions["bitaddr"] = "the address of `RAM` you desire to write" descriptions["bitval"] = "the integer value write to RAM" - descriptions["addr2"] = "the address of [RAM](RAM) you desire to write (segmented on 2)" + descriptions["addr2"] = "the address of `RAM` you desire to write (segmented on 2)" descriptions["val2"] = "the integer value write to RAM (segmented on 2)" - descriptions["addr4"] = "the address of [RAM](RAM) you desire to write (segmented on 4)" + descriptions["addr4"] = "the address of `RAM` you desire to write (segmented on 4)" descriptions["val4"] = "the integer value write to RAM (segmented on 4)" # Because the return type in `fget` is "bool" and is not explicitly documented