diff options
| author | Jade <software@lfcode.ca> | 2021-08-05 19:46:26 -0700 |
|---|---|---|
| committer | Jade <software@lfcode.ca> | 2021-08-10 14:40:26 -0700 |
| commit | 23d398b1848571709a0cbb8a08436f6de56d43a8 (patch) | |
| tree | fb1947d197f94ec8243ae0f7e6f9d6c10ef43b26 | |
| parent | c78cc7ac1f1e89cd2e12d29374e1c5e6110d9217 (diff) | |
| download | rust-23d398b1848571709a0cbb8a08436f6de56d43a8.tar.gz rust-23d398b1848571709a0cbb8a08436f6de56d43a8.zip | |
tree-wide: Fix all the rustdoc warnings
| -rw-r--r-- | clippy_lints/src/needless_continue.rs | 2 | ||||
| -rw-r--r-- | clippy_lints/src/needless_for_each.rs | 2 | ||||
| -rw-r--r-- | clippy_utils/src/diagnostics.rs | 6 | ||||
| -rw-r--r-- | clippy_utils/src/higher.rs | 6 | ||||
| -rw-r--r-- | clippy_utils/src/ty.rs | 2 |
5 files changed, 9 insertions, 9 deletions
diff --git a/clippy_lints/src/needless_continue.rs b/clippy_lints/src/needless_continue.rs index 5088b8bb0d3..5a50cc48d61 100644 --- a/clippy_lints/src/needless_continue.rs +++ b/clippy_lints/src/needless_continue.rs @@ -422,7 +422,7 @@ fn check_and_warn<'a>(cx: &EarlyContext<'_>, expr: &'a ast::Expr) { /// /// is transformed to /// -/// ```ignore +/// ```text /// { /// let x = 5; /// ``` diff --git a/clippy_lints/src/needless_for_each.rs b/clippy_lints/src/needless_for_each.rs index d9aa42fe8ee..9a6ddc72ce5 100644 --- a/clippy_lints/src/needless_for_each.rs +++ b/clippy_lints/src/needless_for_each.rs @@ -122,7 +122,7 @@ impl LateLintPass<'_> for NeedlessForEach { /// 2. Detect use of `return` in `Loop` in the closure body. /// /// NOTE: The functionality of this type is similar to -/// [`crate::utilts::visitors::find_all_ret_expressions`], but we can't use +/// [`clippy_utils::visitors::find_all_ret_expressions`], but we can't use /// `find_all_ret_expressions` instead of this type. The reasons are: /// 1. `find_all_ret_expressions` passes the argument of `ExprKind::Ret` to a callback, but what we /// need here is `ExprKind::Ret` itself. diff --git a/clippy_utils/src/diagnostics.rs b/clippy_utils/src/diagnostics.rs index 7c94474cb35..71cfa196fc3 100644 --- a/clippy_utils/src/diagnostics.rs +++ b/clippy_utils/src/diagnostics.rs @@ -65,7 +65,7 @@ pub fn span_lint<T: LintContext>(cx: &T, lint: &'static Lint, sp: impl Into<Mult /// /// # Example /// -/// ```ignore +/// ```text /// error: constant division of 0.0 with 0.0 will always result in NaN /// --> $DIR/zero_div_zero.rs:6:25 /// | @@ -103,7 +103,7 @@ pub fn span_lint_and_help<'a, T: LintContext>( /// /// # Example /// -/// ```ignore +/// ```text /// error: calls to `std::mem::forget` with a reference instead of an owned value. Forgetting a reference does nothing. /// --> $DIR/drop_forget_ref.rs:10:5 /// | @@ -189,7 +189,7 @@ pub fn span_lint_hir_and_then( /// /// # Example /// -/// ```ignore +/// ```text /// error: This `.fold` can be more succinctly expressed as `.any` /// --> $DIR/methods.rs:390:13 /// | diff --git a/clippy_utils/src/higher.rs b/clippy_utils/src/higher.rs index f32f1109b08..884180f0586 100644 --- a/clippy_utils/src/higher.rs +++ b/clippy_utils/src/higher.rs @@ -195,8 +195,8 @@ pub fn vec_macro<'e>(cx: &LateContext<'_>, expr: &'e hir::Expr<'_>) -> Option<Ve /// - `assert!`, `assert_eq!` and `assert_ne!` /// - `debug_assert!`, `debug_assert_eq!` and `debug_assert_ne!` /// For example: -/// `assert!(expr)` will return Some([expr]) -/// `debug_assert_eq!(a, b)` will return Some([a, b]) +/// `assert!(expr)` will return `Some([expr])` +/// `debug_assert_eq!(a, b)` will return `Some([a, b])` pub fn extract_assert_macro_args<'tcx>(e: &'tcx Expr<'tcx>) -> Option<Vec<&'tcx Expr<'tcx>>> { /// Try to match the AST for a pattern that contains a match, for example when two args are /// compared @@ -283,7 +283,7 @@ pub struct FormatArgsExpn<'tcx> { /// String literal expressions which represent the format string split by "{}" pub format_string_parts: &'tcx [Expr<'tcx>], - /// Symbols corresponding to [`format_string_parts`] + /// Symbols corresponding to [`Self::format_string_parts`] pub format_string_symbols: Vec<Symbol>, /// Expressions like `ArgumentV1::new(arg0, Debug::fmt)` pub args: &'tcx [Expr<'tcx>], diff --git a/clippy_utils/src/ty.rs b/clippy_utils/src/ty.rs index 536d0f006e3..4f9aaf396b8 100644 --- a/clippy_utils/src/ty.rs +++ b/clippy_utils/src/ty.rs @@ -114,7 +114,7 @@ pub fn has_iter_method(cx: &LateContext<'_>, probably_ref_ty: Ty<'_>) -> Option< /// Checks whether a type implements a trait. /// The function returns false in case the type contains an inference variable. -/// See also [`get_trait_def_id`]. +/// See also [`get_trait_def_id`](super::get_trait_def_id). pub fn implements_trait<'tcx>( cx: &LateContext<'tcx>, ty: Ty<'tcx>, |
