chatterino2
Code Issues

Adjust plugin documentation to match implementation (#4540)

Browse Source
This commit is contained in:
Arne
2023-04-14 20:19:24 +02:00
committed by GitHub
parent 52a6f259cf
commit cd6e1c04b2
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/wip-plugins.md
+4 -4
View File
@@ -31,7 +31,7 @@ Example file:
"$schema": "https://raw.githubusercontent.com/Chatterino/chatterino2/master/docs/plugin-info.schema.json", "$schema": "https://raw.githubusercontent.com/Chatterino/chatterino2/master/docs/plugin-info.schema.json",
"name": "Test plugin", "name": "Test plugin",
"description": "This plugin is for testing stuff.", "description": "This plugin is for testing stuff.",
"authors": "Mm2PL", "authors": ["Mm2PL"],
"homepage": "https://github.com/Chatterino/Chatterino2", "homepage": "https://github.com/Chatterino/Chatterino2",
"tags": ["test"], "tags": ["test"],
"version": "0.0.0", "version": "0.0.0",
@@ -100,8 +100,8 @@ Example:
function cmdWords(ctx) function cmdWords(ctx)
-- ctx contains: -- ctx contains:
-- words - table of words supplied to the command including the trigger -- words - table of words supplied to the command including the trigger
-- channelName - name of the channel the command is being run in -- channel_name - name of the channel the command is being run in
c2.system_msg(ctx.channelName, "Words are: " .. table.concat(ctx.words, " ")) c2.system_msg(ctx.channel_name, "Words are: " .. table.concat(ctx.words, " "))
end end
c2.register_command("/words", cmdWords) c2.register_command("/words", cmdWords)
@@ -123,7 +123,7 @@ Example:
function cmdShout(ctx) function cmdShout(ctx)
table.remove(ctx.words, 1) table.remove(ctx.words, 1)
local output = table.concat(ctx.words, " ") local output = table.concat(ctx.words, " ")
c2.send_msg(ctx.channelName, string.upper(output)) c2.send_msg(ctx.channel_name, string.upper(output))
end end
c2.register_command("/shout", cmdShout) c2.register_command("/shout", cmdShout)
``` ```