From c05766e99f3b490efa663788490411c20db4f643 Mon Sep 17 00:00:00 2001
From: nhmall <nhmall@nethack.org>
Date: Sat, 31 May 2025 07:17:40 -0400
Subject: [PATCH] get_freeing_nhfile() comment

---
 src/files.c | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/files.c b/src/files.c
index d91a85fc3..ab4ba9ed8 100644
--- a/src/files.c
+++ b/src/files.c
@@ -1265,6 +1265,15 @@ restore_saved_game(void)
     return nhfp;
 }
 
+/*
+ * This doesn't open any files. It provides a valid (NHFILE *)
+ * to provide to functions that take one as a parameter, with
+ * only the FREEING bit set.
+ *
+ * close_nhfile() can, and should, be called on the returned
+ * (NHFILE *), and it will handle it correctly.
+ */
+
 NHFILE *
 get_freeing_nhfile(void)
 {