diff mbox series

[v3,3/3] rust: macros: simplify Result<()> in function returns

Message ID 20241118-simplify-result-v3-3-6b1566a77eab@iiitd.ac.in (mailing list archive)
State Not Applicable
Headers show
Series rust: simplify Result<()> uses | expand

Checks

Context Check Description
netdev/tree_selection success Not a local patch

Commit Message

Manas via B4 Relay Nov. 18, 2024, 2:37 p.m. UTC
From: Manas <manas18244@iiitd.ac.in>

Functions foo and bar in doctests return `Result<()>` type. This type
can be simply written as `Result` as default type parameters are unit
`()` and `Error` types. Thus keep the usage of `Result` consistent.

Suggested-by: Miguel Ojeda <ojeda@kernel.org>
Link: https://github.com/Rust-for-Linux/linux/issues/1128
Signed-off-by: Manas <manas18244@iiitd.ac.in>
---
 rust/macros/lib.rs | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Boqun Feng Nov. 18, 2024, 8:28 p.m. UTC | #1
On Mon, Nov 18, 2024 at 08:07:00PM +0530, Manas via B4 Relay wrote:
> From: Manas <manas18244@iiitd.ac.in>
> 
> Functions foo and bar in doctests return `Result<()>` type. This type

Same nits here.

> can be simply written as `Result` as default type parameters are unit
> `()` and `Error` types. Thus keep the usage of `Result` consistent.
> 
> Suggested-by: Miguel Ojeda <ojeda@kernel.org>
> Link: https://github.com/Rust-for-Linux/linux/issues/1128
> Signed-off-by: Manas <manas18244@iiitd.ac.in>

Reviewed-by: Boqun Feng <boqun.feng@gmail.com>

Regards,
Boqun

> ---
>  rust/macros/lib.rs | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs
> index 4ab94e44adfe3206faad159e81417ea41a35815b..463920353ca9c408f5d69e2626c13a173bae98d7 100644
> --- a/rust/macros/lib.rs
> +++ b/rust/macros/lib.rs
> @@ -144,11 +144,11 @@ pub fn module(ts: TokenStream) -> TokenStream {
>  /// // Declares a `#[vtable]` trait
>  /// #[vtable]
>  /// pub trait Operations: Send + Sync + Sized {
> -///     fn foo(&self) -> Result<()> {
> +///     fn foo(&self) -> Result {
>  ///         kernel::build_error(VTABLE_DEFAULT_ERROR)
>  ///     }
>  ///
> -///     fn bar(&self) -> Result<()> {
> +///     fn bar(&self) -> Result {
>  ///         kernel::build_error(VTABLE_DEFAULT_ERROR)
>  ///     }
>  /// }
> @@ -158,7 +158,7 @@ pub fn module(ts: TokenStream) -> TokenStream {
>  /// // Implements the `#[vtable]` trait
>  /// #[vtable]
>  /// impl Operations for Foo {
> -///     fn foo(&self) -> Result<()> {
> +///     fn foo(&self) -> Result {
>  /// #        Err(EINVAL)
>  ///         // ...
>  ///     }
> 
> -- 
> 2.47.0
> 
>
diff mbox series

Patch

diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs
index 4ab94e44adfe3206faad159e81417ea41a35815b..463920353ca9c408f5d69e2626c13a173bae98d7 100644
--- a/rust/macros/lib.rs
+++ b/rust/macros/lib.rs
@@ -144,11 +144,11 @@  pub fn module(ts: TokenStream) -> TokenStream {
 /// // Declares a `#[vtable]` trait
 /// #[vtable]
 /// pub trait Operations: Send + Sync + Sized {
-///     fn foo(&self) -> Result<()> {
+///     fn foo(&self) -> Result {
 ///         kernel::build_error(VTABLE_DEFAULT_ERROR)
 ///     }
 ///
-///     fn bar(&self) -> Result<()> {
+///     fn bar(&self) -> Result {
 ///         kernel::build_error(VTABLE_DEFAULT_ERROR)
 ///     }
 /// }
@@ -158,7 +158,7 @@  pub fn module(ts: TokenStream) -> TokenStream {
 /// // Implements the `#[vtable]` trait
 /// #[vtable]
 /// impl Operations for Foo {
-///     fn foo(&self) -> Result<()> {
+///     fn foo(&self) -> Result {
 /// #        Err(EINVAL)
 ///         // ...
 ///     }