docs: add deprecation note

errata-ai · Jun 8, 2024 · ec7b668 · ec7b668
1 parent 1a87d11
commit ec7b668
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/internal/core/format.go b/internal/core/format.go
@@ -10,6 +10,13 @@ import (
 // we only want to lint // or /* comments in a C++ file. Multiple formats are
 // mapped to a single extension (e.g., .java -> .c) because many languages use
 // the same comment delimiters.
+//
+// Deprecated: When possible, we now use tree-sitter grammars to determine the
+// comment delimiters for a given file. See the `lint/code` package for more
+// information.
+//
+// TODO: This should be removed once we have tree-sitter grammars for all
+// languages.
 var CommentsByNormedExt = map[string]map[string]string{
 	".c": {
 		"inline":     `(?:^|\s)(?:(//.+)|(/\*.+\*/))`,