From 0b006fccf9ec4f3c77f56ff24504d8da17863d40 Mon Sep 17 00:00:00 2001
From: 1F616EMO <root@1f616emo.xyz>
Date: Sat, 22 Jun 2024 14:44:22 +0800
Subject: [PATCH] Documentation of new function

---
 mods/default/functions.lua | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/mods/default/functions.lua b/mods/default/functions.lua
index e3298720..d750565c 100644
--- a/mods/default/functions.lua
+++ b/mods/default/functions.lua
@@ -294,6 +294,12 @@ minetest.register_abm({
 --
 
 local in_dig_up = false
+
+---Find all nodes above this one that is the same, then dig them all
+---@param pos vector The position of the base node
+---@param node { name: string, param1: integer, param2: integer } Node table of the base node
+---@param digger ObjectRef The object (e.g. player) digging the node
+---@param max_height The maximum height to search for, excluding the base node
 function default.dig_up(pos, node, digger, max_height)
 	if in_dig_up then return end -- Do not recurse
 	if digger == nil then return end