mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2025-08-29 16:47:56 +00:00
Code Issues Releases Wiki Activity

Remove <!-- -->s in usages

Browse Source 
We fixed the bug in illuaminate, so this should be redundant now.
This commit is contained in:
Jonathan Coates
2020-11-28 17:53:07 +00:00
committed by Jummit
parent b203d3aa0a
commit 79fcc7241b
3 changed files with 20 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
patchwork.md
View File

@@ -343,7 +343,6 @@ Cleanup examples for the various modules
``` ```
Ignored Documentation Changes, these are locate Ignored Documentation Changes, these are locate
```
``` ```
9a749642d294506095e697a3a4345dfe260bd68c 9a749642d294506095e697a3a4345dfe260bd68c
@@ -396,3 +395,9 @@ Try to handle a turtle being broken while ticked
Hopefully fixes #585. Hopefully. Hopefully fixes #585. Hopefully.
``` ```
```
511eea39a11956c82e2c11a47b2e7cad27f9887e
Remove <!-- -->s in usages
```

24
src/main/resources/data/computercraft/lua/rom/modules/main/cc/completion.lua
View File

@@ -45,9 +45,9 @@ end
-- @tparam string text The input string to complete. -- @tparam string text The input string to complete.
-- @tparam[opt] boolean add_space Whether to add a space after the completed name. -- @tparam[opt] boolean add_space Whether to add a space after the completed name.
-- @treturn { string... } A list of suffixes of matching peripherals. -- @treturn { string... } A list of suffixes of matching peripherals.
-- @usage <!-- --> -- @usage
---- local completion = require "cc.completion" -- local completion = require "cc.completion"
---- read(nil, nil, completion.peripheral) -- read(nil, nil, completion.peripheral)
local function peripheral_(text, add_space) local function peripheral_(text, add_space)
expect(1, text, "string") expect(1, text, "string")
expect(2, add_space, "boolean", "nil") expect(2, add_space, "boolean", "nil")
@@ -61,9 +61,9 @@ local sides = redstone.getSides()
-- @tparam string text The input string to complete. -- @tparam string text The input string to complete.
-- @tparam[opt] boolean add_space Whether to add a space after the completed side. -- @tparam[opt] boolean add_space Whether to add a space after the completed side.
-- @treturn { string... } A list of suffixes of matching sides. -- @treturn { string... } A list of suffixes of matching sides.
-- @usage <!-- --> -- @usage
---- local completion = require "cc.completion" -- local completion = require "cc.completion"
---- read(nil, nil, completion.side) -- read(nil, nil, completion.side)
local function side(text, add_space) local function side(text, add_space)
expect(1, text, "string") expect(1, text, "string")
expect(2, add_space, "boolean", "nil") expect(2, add_space, "boolean", "nil")
@@ -75,9 +75,9 @@ end
-- @tparam string text The input string to complete. -- @tparam string text The input string to complete.
-- @tparam[opt] boolean add_space Whether to add a space after the completed settings. -- @tparam[opt] boolean add_space Whether to add a space after the completed settings.
-- @treturn { string... } A list of suffixes of matching settings. -- @treturn { string... } A list of suffixes of matching settings.
-- @usage <!-- --> -- @usage
---- local completion = require "cc.completion" -- local completion = require "cc.completion"
---- read(nil, nil, completion.setting) -- read(nil, nil, completion.setting)
local function setting(text, add_space) local function setting(text, add_space)
expect(1, text, "string") expect(1, text, "string")
expect(2, add_space, "boolean", "nil") expect(2, add_space, "boolean", "nil")
@@ -91,9 +91,9 @@ local command_list
-- @tparam string text The input string to complete. -- @tparam string text The input string to complete.
-- @tparam[opt] boolean add_space Whether to add a space after the completed command. -- @tparam[opt] boolean add_space Whether to add a space after the completed command.
-- @treturn { string... } A list of suffixes of matching commands. -- @treturn { string... } A list of suffixes of matching commands.
-- @usage <!-- --> -- @usage
---- local completion = require "cc.completion" -- local completion = require "cc.completion"
---- read(nil, nil, completion.command) -- read(nil, nil, completion.command)
local function command(text, add_space) local function command(text, add_space)
expect(1, text, "string") expect(1, text, "string")
expect(2, add_space, "boolean", "nil") expect(2, add_space, "boolean", "nil")

4
src/main/resources/data/computercraft/lua/rom/modules/main/cc/pretty.lua
View File

@@ -104,7 +104,7 @@ end
-- --
-- @tparam Doc|string ... The documents to concatenate. -- @tparam Doc|string ... The documents to concatenate.
-- @treturn Doc The concatenated documents. -- @treturn Doc The concatenated documents.
-- @usage <!-- --> -- @usage
-- local pretty = require "cc.pretty" -- local pretty = require "cc.pretty"
-- local doc1, doc2 = pretty.text("doc1"), pretty.text("doc2") -- local doc1, doc2 = pretty.text("doc1"), pretty.text("doc2")
-- print(pretty.concat(doc1, " - ", doc2)) -- print(pretty.concat(doc1, " - ", doc2))
@@ -141,7 +141,7 @@ Doc.__concat = concat --- @local
-- @tparam number depth The number of spaces with which the document should be indented. -- @tparam number depth The number of spaces with which the document should be indented.
-- @tparam Doc doc The document to indent. -- @tparam Doc doc The document to indent.
-- @treturn Doc The nested document. -- @treturn Doc The nested document.
-- @usage <!-- --> -- @usage
-- local pretty = require "cc.pretty" -- local pretty = require "cc.pretty"
-- print(pretty.nest(2, pretty.text("foo\nbar"))) -- print(pretty.nest(2, pretty.text("foo\nbar")))
local function nest(depth, doc) local function nest(depth, doc)