error lang: path:src/tools/clippy/clippy_lints/src/doc/mod.rs · rust-lang/rust

src/tools/clippy/clippy_lints/src/doc/mod.rs RUST 13 matches · showing 5 view file →

use clippy_utils::{is_entrypoint_fn, is_trait_impl_item};
use rustc_data_structures::fx::FxHashSet;
use rustc_errors::Applicability;
use rustc_hir::{Attribute, FieldDef, ImplItemKind, ItemKind, Node, Safety, TraitItemKind};
use rustc_lint::{EarlyContext, EarlyLintPass, LateContext, LateLintPass, LintContext};

· · ·

    /// ### What it does
    /// Checks the doc comments of publicly visible functions that
    /// return a `Result` type and warns if there is no `# Errors` section.
    ///
    /// ### Why is this bad?

· · ·

    /// Documenting the type of errors that can be returned from a
    /// function can help callers write code to handle the errors appropriately.
    ///

· · ·

    /// function can help callers write code to handle the errors appropriately.
    ///
    /// ### Examples

· · ·

    /// Since the following function returns a `Result` it has an `# Errors` section in
    /// its doc comment:
    ///

+ 8 more matches in this file

`auth login`	both terms (AND is implicit)
`auth OR login`	either term
`NOT path:vendor`	exclude matches
`"exact phrase"`	quoted exact match
`/func\s+Test/`	regex
`handler~1`	fuzzy (Levenshtein 1)
`file:*_test.go`	filename glob
`path:pkg/auth/**`	full path glob
`lang:go`	language filter

Search any public repo from your terminal