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

This commit is contained in:
Martin Fischer 2023-08-07 22:20:33 +02:00
parent fa39bca152
commit 5dbe0948d3

View file

@ -10,28 +10,38 @@ pub const TYPE_SPECIFIC_DICTS: &[(&str, StaticDictConfig)] = &[
( (
"py", "py",
StaticDictConfig { StaticDictConfig {
ignore_idents: &["NDArray"], ignore_idents: &[
"NDArray", // numpy.typing.NDArray
],
ignore_words: &[], ignore_words: &[],
}, },
), ),
( (
"rust", "rust",
StaticDictConfig { StaticDictConfig {
ignore_idents: &["flate2"], ignore_idents: &[
ignore_words: &["ser"], "flate2", // https://crates.io/crates/flate2
],
ignore_words: &[
"ser", // serde::ser, serde_json::ser, etc.
],
}, },
), ),
( (
"vim", "vim",
StaticDictConfig { StaticDictConfig {
ignore_idents: &["windo"], ignore_idents: &[
"windo", // https://vimdoc.sourceforge.net/htmldoc/windows.html#:windo
],
ignore_words: &[], ignore_words: &[],
}, },
), ),
( (
"vimscript", "vimscript",
StaticDictConfig { StaticDictConfig {
ignore_idents: &["windo"], ignore_idents: &[
"windo", // https://vimdoc.sourceforge.net/htmldoc/windows.html#:windo
],
ignore_words: &[], ignore_words: &[],
}, },
), ),