]> www.infradead.org Git - users/dwmw2/linux.git/commitdiff
docs: rust: remove spurious item in `expect` list
authorMiguel Ojeda <ojeda@kernel.org>
Sun, 17 Nov 2024 13:31:27 +0000 (14:31 +0100)
committerMiguel Ojeda <ojeda@kernel.org>
Sun, 24 Nov 2024 23:10:29 +0000 (00:10 +0100)
This list started as a "when to prefer `expect`" list, but at some point
during writing I changed it to a "prefer `expect` unless..." one. However,
the first bullet remained, which does not make sense anymore.

Thus remove it. In addition, fix nearby typo.

Fixes: 04866494e936 ("Documentation: rust: discuss `#[expect(...)]` in the guidelines")
Reviewed-by: Alice Ryhl <aliceryhl@google.com>
Reviewed-by: Andreas Hindborg <a.hindborg@kernel.org>
Link: https://lore.kernel.org/r/20241117133127.473937-1-ojeda@kernel.org
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
Documentation/rust/coding-guidelines.rst

index f7194f7124b07c12c8c96e522c1637c1df993135..a2e326b42410f8d27f706b4a00e2ad0339be62ac 100644 (file)
@@ -296,9 +296,7 @@ may happen in several situations, e.g.:
 It also increases the visibility of the remaining ``allow``\ s and reduces the
 chance of misapplying one.
 
-Thus prefer ``except`` over ``allow`` unless:
-
-- The lint attribute is intended to be temporary, e.g. while developing.
+Thus prefer ``expect`` over ``allow`` unless:
 
 - Conditional compilation triggers the warning in some cases but not others.