docs(cli): Add comments to file-type specific ignores

crate-ci · Aug 8, 2023 · 5dbe094 · 5dbe094
1 parent fa39bca
commit 5dbe094
Showing 1 changed file with 15 additions and 5 deletions.
diff --git a/crates/typos-cli/src/file_type_specifics.rs b/crates/typos-cli/src/file_type_specifics.rs
@@ -10,28 +10,38 @@ pub const TYPE_SPECIFIC_DICTS: &[(&str, StaticDictConfig)] = &[
     (
         "py",
         StaticDictConfig {
-            ignore_idents: &["NDArray"],
+            ignore_idents: &[
+                "NDArray", // numpy.typing.NDArray
+            ],
             ignore_words: &[],
         },
     ),
     (
         "rust",
         StaticDictConfig {
-            ignore_idents: &["flate2"],
-            ignore_words: &["ser"],
+            ignore_idents: &[
+                "flate2", // https://crates.io/crates/flate2
+            ],
+            ignore_words: &[
+                "ser", // serde::ser, serde_json::ser, etc.
+            ],
         },
     ),
     (
         "vim",
         StaticDictConfig {
-            ignore_idents: &["windo"],
+            ignore_idents: &[
+                "windo", // https://vimdoc.sourceforge.net/htmldoc/windows.html#:windo
+            ],
             ignore_words: &[],
         },
     ),
     (
         "vimscript",
         StaticDictConfig {
-            ignore_idents: &["windo"],
+            ignore_idents: &[
+                "windo", // https://vimdoc.sourceforge.net/htmldoc/windows.html#:windo
+            ],
             ignore_words: &[],
         },
     ),