From d4ec55be08a2b01aa395faedf986843ad7b98036 Mon Sep 17 00:00:00 2001
From: Jordan Irwin <antumdeluge@gmail.com>
Date: Thu, 29 Jul 2021 12:40:25 -0700
Subject: [PATCH] Add usage docstring for pencil item

---
 init.lua | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/init.lua b/init.lua
index 18589bb..0f34630 100644
--- a/init.lua
+++ b/init.lua
@@ -62,6 +62,16 @@ local sound_handle
 --  @tool cleaner:pencil
 --  @img cleaner_pencil.png
 --  @privs server
+--  @usage
+--  place (right-click):
+--  - when not pointing at a node, changes modes
+--  - when pointing at a node, sets node to be used
+--
+--  use (left-click):
+--  - executes action for current mode:
+--    - erase: erases pointed node
+--    - write: adds node
+--    - swap:  replaces pointed node
 core.register_tool(cleaner.modname .. ":pencil", {
 	description = S("Master Pencil"),
 	inventory_image = "cleaner_pencil.png",