phpDocumentor / phpDocumentor/ReflectionDocBlock
Add more information when an InvalidTag occurs and a link to the phpDocumentor documentation
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- PHP
- Sterne
- 9.4k
- Forks
- 137
- Ø Merge
- 4 T. 2 Std.
- Gemergte PRs (30 T.)
- 1
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem Lesen von StandardTagFactory, InvalidTag und dem im Issue beschriebenen Verhalten der Klasse Tag. Sieh dir anschließend die zugehörige Diskussion in Issue 3378 an. Die Aufgabe ist abgeschlossen, wenn InvalidTag-Instanzen das erwartete Tag-Format und einen Link zur relevanten phpDocumentor-Dokumentation enthalten, damit Fehlerberichte klarere Hinweise geben.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- php
- Bereich
- documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100