From 8a49c3543d093f49ec8d614753f479a577de75e8 Mon Sep 17 00:00:00 2001
From: founfabug <65840268+founfabug@users.noreply.github.com>
Date: Wed, 22 Jan 2025 11:43:01 +1100
Subject: [PATCH] Update gmc-cfg.md

Added note on comments being removed by Godot editor
---
 docs/gmc/reference/gmc-cfg.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/docs/gmc/reference/gmc-cfg.md b/docs/gmc/reference/gmc-cfg.md
index 0cf1180e78..f4d4c24a79 100644
--- a/docs/gmc/reference/gmc-cfg.md
+++ b/docs/gmc/reference/gmc-cfg.md
@@ -6,6 +6,10 @@ title: GMC Configuration File
 
 The *gmc.cfg* configuration file in your Godot project root contains options for customizing GMC behavior. It uses INI formatting and its supported features are documented here.
 
+!!! note
+
+    Currently the Godot engine will remove comments from this file when it chooses to rewrite it.
+    
 ### Local Overrides
 
 Any configuration options in *gmc.cfg* can be overridden with a local file *gmc.local.cfg* in the Godot User Data folder. This allows you to commit the primary configuration to version control while still having platform-specific configurations (e.g. MPF executable path and logging levels) on each machine.