phpDocumentor / phpDocumentor/ReflectionDocBlock
Add more information when an InvalidTag occurs and a link to the phpDocumentor documentation
Personne n'a encore pris cette issue.
- Langage dominant
- PHP
- Étoiles
- 9.4k
- Forks
- 137
- Merge moyen
- 4 j 2 h
- PR mergées (30 j)
- 1
Description
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
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par lire StandardTagFactory, InvalidTag et le comportement de la classe Tag décrit dans l’issue, puis consultez la discussion associée dans l’issue 3378. Le travail est terminé lorsque les instances de InvalidTag incluent le format de tag attendu ainsi qu’un lien vers la documentation phpDocumentor pertinente, afin que les rapports d’erreur fournissent des indications plus claires.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- php
- Domaine
- documentation
- Type d'issue
- Fonctionnalité
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100