Improve docstrings on exceptions
I maintainer di solito rispondono entro 10 giorni
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 45/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Inizia in tuf/api/metadata.py, nelle docstring delle eccezioni intorno alle righe indicate 185 e 346, e confronta i due stili documentati. Decidi una convenzione coerente per le docstring delle eccezioni, aggiorna le docstring interessate e documenta la convenzione in un punto qualsiasi del progetto; il lavoro è completato quando gli stili sono coerenti e le indicazioni sono disponibili.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Current behavior:
Currently, in tuf/api/metadata.py we are using multiple ways to document our custom TUF exceptions.
There are two main ways of how we handle exceptions:
- there are places where we define an exception with the full module name:
https://github.com/theupdateframework/python-tuf/blob/0f1fc6e33cbc4d4c6b502b9f8c64b119d1a4ad2f/tuf/api/metadata.py#L185 - and in other cases, we document only the name of the exception: https://github.com/theupdateframework/python-tuf/blob/0f1fc6e33cbc4d4c6b502b9f8c64b119d1a4ad2f/tuf/api/metadata.py#L346
Expected behavior:
Decide how we want to document our exceptions and stick to that.
Document how we should write docstrings about exceptions somewhere.
I didn't find any mentions about the exception docstrings in the Google Python guidelines
- Lingua principale
- Python
- Stelle
- 1.7k
- Fork
- 304
- Merge medio
- 9h 25m
- PR unite (30g)
- 14
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di theupdateframework/python-tuf
-
switch to main branch?Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
theupdateframework/python-tuf#3001 ·
I maintainer di solito rispondono entro 10 giorni
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 42/100
theupdateframework/python-tuf#2979 · 1 commento ·
I maintainer di solito rispondono entro 10 giorni
-
Use Immutable ReleasesApertaenhancement github_actions
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
theupdateframework/python-tuf#2920 · 1 commento · 2 reazioni ·
I maintainer di solito rispondono entro 10 giorni
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
theupdateframework/python-tuf#2842 · 3 commenti ·
I maintainer di solito rispondono entro 10 giorni
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
theupdateframework/python-tuf#2836 · 7 commenti ·
I maintainer di solito rispondono entro 10 giorni
Tutte le issue di theupdateframework/python-tuf
Issue simili
-
correction metadata
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
acl-org/acl-anthology#10104 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
bug status/needs-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
prowler-cloud/prowler#12885 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Bug in GaussianTailProbabilityCalibrator: running_statistics=False still uses a windowed varianceApertabug good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
selimfirat/pysad#107 ·
I maintainer di solito rispondono entro 1 giorno
-
bug ci-failure high priority
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
vllm-project/vllm-omni#8194 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
I maintainer di solito rispondono entro 1 giorno