From 31f6846af943783aea7cacd2ab4118aeea6830dc Mon Sep 17 00:00:00 2001
From: Jesse Nusbaumer <nusbaume@ucar.edu>
Date: Thu, 22 Aug 2024 13:42:37 -0600
Subject: [PATCH] Add comment and URL about Github keywords.

---
 .github/scripts/branch_pr_issue_closer.py | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/.github/scripts/branch_pr_issue_closer.py b/.github/scripts/branch_pr_issue_closer.py
index 53f0352d..43da6831 100755
--- a/.github/scripts/branch_pr_issue_closer.py
+++ b/.github/scripts/branch_pr_issue_closer.py
@@ -35,6 +35,12 @@
 #fix, fixes, fixed
 #resolve, resolves, resolved
 
+#The keywords are designed to match
+#the keywords that exist in Github
+#already for default branches, which
+#can be found here:
+#https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue
+
 #Create relevant regex patterns:
 _CLOSE_KEY              = r'close[sd]?'
 _FIX_KEY                = r'fix(e[sd])?'