From 79fcc7241b1d6ae8853e1695915b9898e6714577 Mon Sep 17 00:00:00 2001
From: Jonathan Coates <git@squiddev.cc>
Date: Sat, 28 Nov 2020 17:53:07 +0000
Subject: [PATCH] Remove <!-- -->s in usages

We fixed the bug in illuaminate, so this should be redundant now.
---
 patchwork.md                                  |  7 +++++-
 .../lua/rom/modules/main/cc/completion.lua    | 24 +++++++++----------
 .../lua/rom/modules/main/cc/pretty.lua        |  4 ++--
 3 files changed, 20 insertions(+), 15 deletions(-)

diff --git a/patchwork.md b/patchwork.md
index ea1606f6f..4b81f471b 100644
--- a/patchwork.md
+++ b/patchwork.md
@@ -343,7 +343,6 @@ Cleanup examples for the various modules
 ```
 
 Ignored Documentation Changes, these are locate
-```
 
 ```
 9a749642d294506095e697a3a4345dfe260bd68c
@@ -396,3 +395,9 @@ Try to handle a turtle being broken while ticked
 
 Hopefully fixes #585. Hopefully.
 ```
+
+```
+511eea39a11956c82e2c11a47b2e7cad27f9887e
+
+Remove <!-- -->s in usages 
+```
diff --git a/src/main/resources/data/computercraft/lua/rom/modules/main/cc/completion.lua b/src/main/resources/data/computercraft/lua/rom/modules/main/cc/completion.lua
index ce94ab81c..67a83bdbc 100644
--- a/src/main/resources/data/computercraft/lua/rom/modules/main/cc/completion.lua
+++ b/src/main/resources/data/computercraft/lua/rom/modules/main/cc/completion.lua
@@ -45,9 +45,9 @@ end
 -- @tparam string text The input string to complete.
 -- @tparam[opt] boolean add_space Whether to add a space after the completed name.
 -- @treturn { string... } A list of suffixes of matching peripherals.
--- @usage <!-- -->
----- local completion = require "cc.completion"
----- read(nil, nil, completion.peripheral)
+-- @usage
+--     local completion = require "cc.completion"
+--     read(nil, nil, completion.peripheral)
 local function peripheral_(text, add_space)
     expect(1, text, "string")
     expect(2, add_space, "boolean", "nil")
@@ -61,9 +61,9 @@ local sides = redstone.getSides()
 -- @tparam string text The input string to complete.
 -- @tparam[opt] boolean add_space Whether to add a space after the completed side.
 -- @treturn { string... } A list of suffixes of matching sides.
--- @usage <!-- -->
----- local completion = require "cc.completion"
----- read(nil, nil, completion.side)
+-- @usage
+--     local completion = require "cc.completion"
+--     read(nil, nil, completion.side)
 local function side(text, add_space)
     expect(1, text, "string")
     expect(2, add_space, "boolean", "nil")
@@ -75,9 +75,9 @@ end
 -- @tparam string text The input string to complete.
 -- @tparam[opt] boolean add_space Whether to add a space after the completed settings.
 -- @treturn { string... } A list of suffixes of matching settings.
--- @usage <!-- -->
----- local completion = require "cc.completion"
----- read(nil, nil, completion.setting)
+-- @usage
+--     local completion = require "cc.completion"
+--     read(nil, nil, completion.setting)
 local function setting(text, add_space)
     expect(1, text, "string")
     expect(2, add_space, "boolean", "nil")
@@ -91,9 +91,9 @@ local command_list
 -- @tparam string text The input string to complete.
 -- @tparam[opt] boolean add_space Whether to add a space after the completed command.
 -- @treturn { string... } A list of suffixes of matching commands.
--- @usage <!-- -->
----- local completion = require "cc.completion"
----- read(nil, nil, completion.command)
+-- @usage
+--     local completion = require "cc.completion"
+--     read(nil, nil, completion.command)
 local function command(text, add_space)
     expect(1, text, "string")
     expect(2, add_space, "boolean", "nil")
diff --git a/src/main/resources/data/computercraft/lua/rom/modules/main/cc/pretty.lua b/src/main/resources/data/computercraft/lua/rom/modules/main/cc/pretty.lua
index 37a70a515..9a3aa7b0a 100644
--- a/src/main/resources/data/computercraft/lua/rom/modules/main/cc/pretty.lua
+++ b/src/main/resources/data/computercraft/lua/rom/modules/main/cc/pretty.lua
@@ -104,7 +104,7 @@ end
 --
 -- @tparam Doc|string ... The documents to concatenate.
 -- @treturn Doc The concatenated documents.
--- @usage <!-- -->
+-- @usage
 --     local pretty = require "cc.pretty"
 --     local doc1, doc2 = pretty.text("doc1"), pretty.text("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 Doc    doc   The document to indent.
 -- @treturn Doc The nested document.
--- @usage <!-- -->
+-- @usage
 --     local pretty = require "cc.pretty"
 --     print(pretty.nest(2, pretty.text("foo\nbar")))
 local function nest(depth, doc)