Skip to content

Commit

Permalink
Improve lint documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
popzxc committed Jun 28, 2021
1 parent f0ffeb7 commit 94dd5bb
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions clippy_lints/src/disallowed_script_idents.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,21 @@ declare_clippy_lint! {
///
/// This lint doesn't take into account non-text scripts such as `Unknown` and `Linear_A`.
/// It also ignores the `Common` script type.
/// While configuring, be sure to use official script names from [the list of supported scripts][supported_scripts]
/// and replace spaces with undescores.
/// While configuring, be sure to use official script name [aliases] from
/// [the list of supported scripts][supported_scripts].
///
/// For example, `Syloti Nagri` must be represented as `"Syloti_Nagri`".
/// See also: [`non_ascii_idents`].
///
/// See also: [`non_ascii_idents`](https://doc.rust-lang.org/rustc/lints/listing/allowed-by-default.html#non-ascii-idents).
///
/// [supported_scripts]: http://www.unicode.org/standard/supported.html
/// [aliases]: http://www.unicode.org/reports/tr24/tr24-31.html#Script_Value_Aliases
/// [supported_scripts]: https://www.unicode.org/iso15924/iso15924-codes.html
///
/// **Why is this bad?** It may be not desired to have many different scripts for
/// identifiers in the codebase.
///
/// Note that if you only want to allow plain English, you might want to use
/// built-in `non_ascii_idents` lint instead.
/// built-in [`non_ascii_idents`] lint instead.
///
/// [`non_ascii_idents`]: https://doc.rust-lang.org/rustc/lints/listing/allowed-by-default.html#non-ascii-idents
///
/// **Known problems:** None.
///
Expand Down

0 comments on commit 94dd5bb

Please sign in to comment.