Add reason config example for disallowed_type

Co-authored-by: James Hinshelwood <james.hinshelwood@bigpayme.com>
This commit is contained in:
James Hinshelwood 2021-10-11 08:25:30 +01:00
parent 72078faf91
commit 857a4073b8
No known key found for this signature in database
GPG key ID: E271BBE0B9FAFC09

View file

@ -21,7 +21,15 @@ declare_clippy_lint! {
/// An example clippy.toml configuration:
/// ```toml
/// # clippy.toml
/// disallowed-types = ["std::collections::BTreeMap"]
/// disallowed-types = [
/// # Can use a string as the path of the disallowed type.
/// "std::collections::BTreeMap",
/// # Can also use an inline table with a `path` key.
/// { path = "std::net::TcpListener" },
/// # When using an inline table, can add a `reason` for why the type
/// # is disallowed.
/// { path = "std::net::Ipv4Addr", reason = "no IPv4 allowed" },
/// ]
/// ```
///
/// ```rust,ignore