Skip to content

Commit d317389

Browse files
committed
Improve lint documentation
1 parent f0ffeb7 commit d317389

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

clippy_lints/src/disallowed_script_idents.rs

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,25 @@ declare_clippy_lint! {
1111
///
1212
/// This lint doesn't take into account non-text scripts such as `Unknown` and `Linear_A`.
1313
/// It also ignores the `Common` script type.
14-
/// While configuring, be sure to use official script names from [the list of supported scripts][supported_scripts]
15-
/// and replace spaces with undescores.
14+
/// While configuring, be sure to use official script name [aliases] from
15+
/// [the list of supported scripts][supported_scripts].
1616
///
17-
/// For example, `Syloti Nagri` must be represented as `"Syloti_Nagri`".
17+
/// Note that [`Katakana_Or_Hiragana`] alias is a special case that is no longer should be used. Use `Katakana` and
18+
/// `Hiragana` individually, if you need them.
1819
///
19-
/// See also: [`non_ascii_idents`](https://doc.rust-lang.org/rustc/lints/listing/allowed-by-default.html#non-ascii-idents).
20+
/// See also: [`non_ascii_idents`].
2021
///
21-
/// [supported_scripts]: http://www.unicode.org/standard/supported.html
22+
/// [aliases]: http://www.unicode.org/reports/tr24/tr24-31.html#Script_Value_Aliases
23+
/// [supported_scripts]: https://www.unicode.org/iso15924/iso15924-codes.html
24+
/// [`Katakana_Or_Hiragana`]: https://unicode.org/reports/tr31/#Specific_Character_Adjustments
2225
///
2326
/// **Why is this bad?** It may be not desired to have many different scripts for
2427
/// identifiers in the codebase.
2528
///
2629
/// Note that if you only want to allow plain English, you might want to use
27-
/// built-in `non_ascii_idents` lint instead.
30+
/// built-in [`non_ascii_idents`] lint instead.
31+
///
32+
/// [`non_ascii_idents`]: https://doc.rust-lang.org/rustc/lints/listing/allowed-by-default.html#non-ascii-idents
2833
///
2934
/// **Known problems:** None.
3035
///

0 commit comments

Comments
 (0)