user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Abide by allow/expect in bodies for missing_panics_doc

Browse source
This commit is contained in:
Alex Macleod 2025-03-14 15:22:33 +00:00
parent c89368537c
commit 6ee4f34741
4 changed files with 62 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

6
clippy_lints/src/doc/missing_headers.rs
View file

@ -3,7 +3,7 @@ use clippy_utils::diagnostics::{span_lint, span_lint_and_note};
use clippy_utils::macros::{is_panic, root_macro_call_first_node};
use clippy_utils::ty::{get_type_diagnostic_name, implements_trait_with_env, is_type_diagnostic_item};
use clippy_utils::visitors::Visitable;
use clippy_utils::{is_doc_hidden, method_chain_args, return_ty};
use clippy_utils::{fulfill_or_allowed, is_doc_hidden, method_chain_args, return_ty};
use rustc_hir::intravisit::{self, Visitor};
use rustc_hir::{AnonConst, BodyId, Expr, FnSig, OwnerId, Safety};
use rustc_lint::LateContext;
@ -129,6 +129,7 @@ impl<'tcx> Visitor<'tcx> for FindPanicUnwrap<'_, 'tcx> {
Some(sym::assert_macro | sym::assert_eq_macro | sym::assert_ne_macro)
))
&& !self.cx.tcx.hir_is_inside_const_context(expr.hir_id)
&& !fulfill_or_allowed(self.cx, MISSING_PANICS_DOC, [expr.hir_id])
{
self.panic_span = Some(macro_call.span);
}
@ -140,7 +141,8 @@ impl<'tcx> Visitor<'tcx> for FindPanicUnwrap<'_, 'tcx> {
if matches!(
get_type_diagnostic_name(self.cx, receiver_ty),
Some(sym::Option | sym::Result)
) {
) && !fulfill_or_allowed(self.cx, MISSING_PANICS_DOC, [expr.hir_id])
{
self.panic_span = Some(expr.span);
}
}

13
clippy_lints/src/doc/mod.rs
View file

@ -188,6 +188,19 @@ declare_clippy_lint! {
/// }
/// }
/// ```
///
/// Individual panics within a function can be ignored with `#[expect]` or
/// `#[allow]`:
///
/// ```no_run
/// # use std::num::NonZeroUsize;
/// pub fn will_not_panic(x: usize) {
/// #[expect(clippy::missing_panics_doc, reason = "infallible")]
/// let y = NonZeroUsize::new(1).unwrap();
///
/// // If any panics are added in the future the lint will still catch them
/// }
/// ```
#[clippy::version = "1.51.0"]
pub MISSING_PANICS_DOC,
pedantic,