[PATCH] docs: rust: remove spurious item in `expect` list

Miguel Ojeda posted 1 patch 1 year, 2 months ago
Documentation/rust/coding-guidelines.rst | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
[PATCH] docs: rust: remove spurious item in `expect` list
Posted by Miguel Ojeda 1 year, 2 months ago
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")
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
 Documentation/rust/coding-guidelines.rst | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/Documentation/rust/coding-guidelines.rst b/Documentation/rust/coding-guidelines.rst
index f7194f7124b0..a2e326b42410 100644
--- a/Documentation/rust/coding-guidelines.rst
+++ b/Documentation/rust/coding-guidelines.rst
@@ -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.
 

base-commit: b2603f8ac8217bc59f5c7f248ac248423b9b99cb
-- 
2.47.0
Re: [PATCH] docs: rust: remove spurious item in `expect` list
Posted by Miguel Ojeda 1 year, 2 months ago
On Sun, Nov 17, 2024 at 2:31 PM Miguel Ojeda <ojeda@kernel.org> wrote:
>
> 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")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

Applied to `rust-next` -- thanks everyone!

Cheers,
Miguel
Re: [PATCH] docs: rust: remove spurious item in `expect` list
Posted by Andreas Hindborg 1 year, 2 months ago
"Miguel Ojeda" <ojeda@kernel.org> writes:

> 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")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
> ---


Reviewed-by: Andreas Hindborg <a.hindborg@kernel.org>


Best regards,
Andreas Hindborg
Re: [PATCH] docs: rust: remove spurious item in `expect` list
Posted by Alice Ryhl 1 year, 2 months ago
On Sun, Nov 17, 2024 at 2:31 PM Miguel Ojeda <ojeda@kernel.org> wrote:
>
> 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")
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

Reviewed-by: Alice Ryhl <aliceryhl@google.com>