rust-lang/rust-clippy

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

Open

#1.790 geöffnet am 27. Mai 2017

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (1 zugewiesene Person)Rust (1.391 Forks)batch import
A-lintL-guidelinesT-middlegood first issue

Repository-Metriken

Stars
 (10.406 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 19T 22h) (113 gemergte PRs in 30 T)

Beschreibung

As per Function docs include error, panic, and safety considerations.

Contributor Guide

Research-Richtung
Überprüfen Sie die Rust API Richtlinie zur Dokumentation von Fehlerbedingungen. Finden Sie Clippy Lint Funktionen, denen ein 'Errors' Abschnitt in ihren Dokumentationskommentaren fehlt, und fügen Sie ihn hinzu.
Tech Stack
rust
Domain
documentationdeveloper experience
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitRust
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85