From 18eb8fd1c448167101664fd1a7c892cc9856f370 Mon Sep 17 00:00:00 2001
From: Oleksandr Smirnov <olexsmir@gmail.com>
Date: Thu, 4 Sep 2025 16:00:03 +0300
Subject: [PATCH] docs: add note about the generate function

---
 lua/gopher/comment.lua | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/lua/gopher/comment.lua b/lua/gopher/comment.lua
index 76090ec..16aef1f 100644
--- a/lua/gopher/comment.lua
+++ b/lua/gopher/comment.lua
@@ -10,6 +10,9 @@ local log = require "gopher._utils.log"
 local u = require "gopher._utils"
 local comment = {}
 
+--- NOTE: The order of functions executed inside this function is IMPORTANT.
+--- This function is extremely fragile; run tests after making any changes.
+---
 ---@param bufnr integer
 ---@param line string
 ---@return string