rust-lang/rust-clippy

Split `missing_docs_in_private_items` into various lints

Open

#5.736 aberto em 22 de jun. de 2020

Ver no GitHub
 (7 comments) (6 reactions) (0 assignees)Rust (1.391 forks)batch import
C-enhancementgood first issue

Métricas do repositório

Stars
 (10.406 stars)
Métricas de merge de PR
 (Mesclagem média 19d 22h) (113 fundiu PRs em 30d)

Description

Would it be feasible and acceptable to split missing_docs_in_private_items into a few different lints? I find myself quite frequently adding #[allow] to enum variants and struct fields, in large part because the naming is typically self-explanatory. Even splitting the lint in two (fields/variants and everything else) would be incredibly useful for me, and would avoid cluttering declarations with unnecessary (imo) #[allow] attributes.

Having different lints for modules and top-level crate documentation would also be great, but are less important to me.

Guia do colaborador

Direção de pesquisa
Estude a implementação existente do lint `missing docs in private items`, depois crie novos lints para campos, variantes, módulos, etc., seguindo as diretrizes de contribuição do clippy.
Pilha de tecnologia
rust
Domain
tooling
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
RustClippy linting basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60