Improve docs of LuaCanvas lib for TASVideos wiki

YoshiRulz · YoshiRulz · commit 611e8e369ca0 · 2026-03-28T05:18:55.000+10:00
diff --git a/src/BizHawk.Client.EmuHawk/tools/Lua/LuaCanvas.cs b/src/BizHawk.Client.EmuHawk/tools/Lua/LuaCanvas.cs
@@ -11,7 +11,7 @@
 // ReSharper disable UnusedMember.Global
 namespace BizHawk.Client.EmuHawk
 {
-	[Description("Represents a canvas object returned by the gui.createcanvas() method")]
+	[Description("Represents a canvas object, as returned by the `gui.createcanvas()` method.\nNote that the member functions do not have a `self` parameter, and so must be called with the regular invocation syntax, not the OOP syntax.")]
 	public sealed class LuaCanvas : Form
 	{
 		private readonly EmulationLuaLibrary _emuLib;

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`// ReSharper disable UnusedMember.Global`
`12`	`12`	`namespace BizHawk.Client.EmuHawk`
`13`	`13`	`{`
`14`		`- [Description("Represents a canvas object returned by the gui.createcanvas() method")]`
	`14`	+ [Description("Represents a canvas object, as returned by the `gui.createcanvas()` method.\nNote that the member functions do not have a `self` parameter, and so must be called with the regular invocation syntax, not the OOP syntax.")]
`15`	`15`	`public sealed class LuaCanvas : Form`
`16`	`16`	`{`
`17`	`17`	`private readonly EmulationLuaLibrary _emuLib;`