phpDocumentor / phpDocumentor/ReflectionDocBlock
Add more information when an InvalidTag occurs and a link to the phpDocumentor documentation
Nessuno ha ancora preso questa issue.
- Lingua principale
- PHP
- Stelle
- 9.4k
- Fork
- 137
- Merge medio
- 4g 2h
- PR unite (30g)
- 1
Descrizione
In issue https://github.com/phpDocumentor/phpDocumentor/issues/3378, there was some confusion because the Author tag does not support a description. When the StandardTagFactory encounters a situation where an InvalidTag is generated, it would be nice if it could ask the Tag class what the expected format is and a link to the documentation; and include that in the InvalidTag so that phpDocumentor can provide better error messages in the error report
Guida per i contributori
Apri 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.
Direzione di ricerca
Inizia leggendo StandardTagFactory, InvalidTag e il comportamento della classe Tag descritto nell’issue, quindi esamina la discussione correlata nell’issue 3378. Il lavoro è completato quando le istanze di InvalidTag includono il formato del tag previsto e un link alla documentazione pertinente di phpDocumentor, così che i report degli errori forniscano indicazioni più chiare.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- php
- Ambito
- documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100