Rust API Guideline: Function docs include error conditions in "Errors" section

Métricas do repositório

Stars

10.406 stars (10.406 stars)

Métricas de merge de PR

Mesclagem média 19d 22h (Mesclagem média 19d 22h)113 fundiu PRs em 30d (113 fundiu PRs em 30d)

Description

Guia do colaborador

Direção de pesquisa

Consulte a diretriz da API Rust sobre documentar condições de erro. Encontre funções de lint do Clippy que não possuem uma seção 'Errors' em seus comentários de documentação e adicione a.

Pilha de tecnologia

rust

Domain

documentationdeveloper experience

Tipo Issue

Documentação

DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.

1

Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.

Menos de 1 hora

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

GitRust

Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.

85