Skip to content

Commit 2d9ca94

Browse files
committed
Auto merge of #10425 - smoelius:docs, r=llogiq
Two small documentation improvements The `wrong_self_convention` changes are for grammar and accuracy. The `must_use_candidate` change is because that lint flags only exported functions: https://github.com/rust-lang/rust-clippy/blob/8b65632b6ef737979d42f83664271d6baa8c0270/clippy_lints/src/functions/must_use.rs#L27-L31 changelog: `wrong_self_convention` and `must_use_candidate` documentation improvements
2 parents ba86a99 + 90ba82b commit 2d9ca94

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

clippy_lints/src/functions/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ declare_clippy_lint! {
185185
/// ### Examples
186186
/// ```rust
187187
/// // this could be annotated with `#[must_use]`.
188-
/// fn id<T>(t: T) -> T { t }
188+
/// pub fn id<T>(t: T) -> T { t }
189189
/// ```
190190
#[clippy::version = "1.40.0"]
191191
pub MUST_USE_CANDIDATE,

clippy_lints/src/methods/mod.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -340,8 +340,9 @@ declare_clippy_lint! {
340340

341341
declare_clippy_lint! {
342342
/// ### What it does
343-
/// Checks for methods with certain name prefixes and which
344-
/// doesn't match how self is taken. The actual rules are:
343+
/// Checks for methods with certain name prefixes or suffixes, and which
344+
/// do not adhere to standard conventions regarding how `self` is taken.
345+
/// The actual rules are:
345346
///
346347
/// |Prefix |Postfix |`self` taken | `self` type |
347348
/// |-------|------------|-------------------------------|--------------|

0 commit comments

Comments
 (0)