; * admin/check-doc-strings: Add note for future development.

(cherry picked from commit 0cc651acddb87180357ab8ff4adcbac8d6174e50)

diff --git a/admin/check-doc-strings b/admin/check-doc-strings
index ced8989b2d24093b57d10bfe65bb5e331d678701..df66acdafe06b6b898fd57ccb811ad825888a7c6 100755 (executable)
--- a/admin/check-doc-strings
+++ b/admin/check-doc-strings
@@ -5,6 +5,18 @@ eval 'exec perl -S $0 "$@"' # Portability kludge
 # Author: Martin Buchholz
 # This program is in the public domain.
 
+# NOTE ADDED 2025-02-22:
+#
+# This is an old script that doesn't necessarily work very well with
+# today's sources.  If anyone wants to fix it up, it might be worth the
+# effort, as it could help catch some mistakes that we have overlooked.
+#
+# If you want to work on this, consider fundamentally rethinking the
+# approach.  Instead of flagging anything that *might* be an error,
+# maybe it should flag only things that we are *sure* are an error.
+# That would make it possible to run this as a matter of routine, just
+# as we already do with codespell (see "admin/run-codespell").
+
 use strict;
 use warnings;
 use POSIX;