Skip to content

Commit

Permalink
Update documentation for new_ret_no_self
Browse files Browse the repository at this point in the history
The lint was changed to be more lenient than the documentation implies in PR rust-lang#3338.
Related issue rust-lang#3313
  • Loading branch information
Emerentius authored Apr 10, 2020
1 parent 34763a5 commit ed72dc4
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions clippy_lints/src/methods/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -730,7 +730,7 @@ declare_clippy_lint! {
}

declare_clippy_lint! {
/// **What it does:** Checks for `new` not returning `Self`.
/// **What it does:** Checks for `new` not returning a type that contains `Self`.
///
/// **Why is this bad?** As a convention, `new` methods are used to make a new
/// instance of a type.
Expand All @@ -747,9 +747,31 @@ declare_clippy_lint! {
/// }
/// }
/// ```
///
/// ```rust
/// # struct Foo;
/// # struct FooError;
/// impl Foo {
/// // Good. Return type contains `Self`
/// fn new() -> Result<Foo, FooError> {
/// # Ok(Foo)
/// }
/// }
/// ```
///
/// ```rust
/// # struct Foo;
/// struct Bar(Foo);
/// impl Foo {
/// // Bad. The type name must contain `Self`.
/// fn new() -> Bar {
/// # Bar(Foo)
/// }
/// }
/// ```
pub NEW_RET_NO_SELF,
style,
"not returning `Self` in a `new` method"
"not returning type containing `Self` in a `new` method"
}

declare_clippy_lint! {
Expand Down

0 comments on commit ed72dc4

Please sign in to comment.