Fix spelling of "Known problems section" of interior_mutable_key

This commit is contained in:
Philipp Krones 2020-09-10 17:08:10 +02:00 committed by GitHub
parent d712d7f700
commit 36a864854f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -12,10 +12,10 @@ declare_clippy_lint! {
/// `BtreeSet` rely on either the hash or the order of keys be unchanging,
/// so having types with interior mutability is a bad idea.
///
/// **Known problems:** It's correct to use a struct, that contains interior mutability,
/// as a key; when its `Hash` implementation doesn't access any these interior mutable types.
/// However, this lint is unable to recognise it so cause a false positive.
/// `bytes` ctate is a great example of this.
/// **Known problems:** It's correct to use a struct, that contains interior mutability
/// as a key, when its `Hash` implementation doesn't access any of the interior mutable types.
/// However, this lint is unable to recognize this, so it causes a false positive in theses cases.
/// The `bytes` crate is a great example of this.
///
/// **Example:**
/// ```rust