qdrant/qdrant-client

Add "raises <exception type>" to docstrings

Offen

#348 geöffnet am 24.10.2023

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Python (231 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (1.296 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 19T 5h) (6 gemergte PRs in 30 T)

Beschreibung

Dieses Issue enthält keine Beschreibung.

Contributor Guide

Research-Richtung
Untersuche die Docstrings im Python Client Code, insbesondere Methoden, die Ausnahmen auslösen können. Füge `:raises ExceptionType:` Beschreibungen gemäß dem vorhandenen Docstring Stil hinzu.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
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
GitPython
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75